Welcome to COW Rest API this is the first step to decentralize food supply chains.
- MEI-CM project at Politécnico de Leiria
- Developed since 09/2021 until 02/2023
- Review by: catarinareis
- ESTG - School of Technology and Management
- ciTechCare - Center for Innovative Care and Health Technology
- Install JDK 17.
- Create a Hedera Account in Hedera Portal
https://portal.hedera.com/register. (if you don't own a Hedera account already) - Create text file in the root directory of the project named
.envand add the following information.
#Hedera Configurations
OPERATOR_ID=account_id_in_string_format
OPERATOR_KEY=account_private_key_in_string_format
#Project Configuration
PROJECT_PATH=project_path_in_string_format
- Install a database service and configure a user to access it.
- Create text file in the resources folder of the project named
application.properties.
- MacOS application.properties tested with MariaDB
spring.datasource.url=datasource_url_in_string_format
spring.datasource.username=datasource_username_in_string_format
spring.datasource.password=datasource_pwd_in_string_format
spring.datasource.driver-class-name=driver_class_in_string_format
jwt.secret=jwt_secret_in_string_format
Read more in https://mariadb.com/kb/en/documentation/
- Windows OS application.properties tested with SQLServer
spring.datasource.url=datasource_url_in_string_format
spring.datasource.username=datasource_username_in_string_format
spring.datasource.password=datasource_pwd_in_string_format
spring.datasource.driver-class-name=driver_class_in_string_format
spring.jpa.show-sql=jpa_show_sql_bool
spring.jpa.hibernate.ddl-auto=hibernate_ddl_auto_bool
spring.jpa.properties.hibernate.format_sql=hibernate_format_sql_in_string_format
spring.jpa.properties.hibernate.dialect=hibernate_dialect_in_string_format
jwt.secret=jwt_secret_in_string_format
Read more in https://learn.microsoft.com/en-us/sql/relational-databases/databases/create-a-database?view=sql-server-ver16
- Check
pom.xmlto comment/uncomment necessary dependencies depending on OS. - Run
COWApplication - Check
http://localhost:8080/swagger-ui/to view endpoints available.
- A .env.example is provided to help the setup of the project.
- An application.properties.example is provided to help the setup of the project.
We appreciate and welcome contributions! To contribute to the project, please follow these guidelines:
- Fork the repository.
- Create a new branch.
- Make your changes and ensure they are appropriately documented.
- Test your changes thoroughly.
- Submit a pull request, describing the changes you have made.
- Our team will review your contribution, provide feedback if necessary, and merge it once it meets the required standards.
Cow API is licensed under a Creative Commons Attribution 4.0 International License.
cow-api by Bernardo Figueiredo is licensed under CC BY-NC-SA 4.0
If you have any questions, suggestions, or feedback, please feel free to contact us:
- Email: [bernardo.figueiredo@outlook.com]
- GitHub: bernardo-rf
- Trello: cow-api