Carbon footprint calculator for products focused on the food industry 🍔
Installation and Requirements • How to run • Api documentation • Architecture • License
These instructions will get you a copy of the project up and running on your local machine for development.
These instructions will get you a copy of the project up and running on your local machine for development. Before we install the application we need these systems and tools configured and installed:
It is very easy to install and upload the application. Just follow the steps below and everything will be fine! 🎉
git clone https://github.com/thalees/carbon-footprint-calculator
cd carbon-footprint-calculator
Open your favorite IDE and build the project using gradle:
./gradlew build
To run the calculation flow it is necessary to go up and configure the infrastructure and create the queue that will be used by the application. To mock AWS services we are using localstack and for the database we are using MongoDB. To run it, just run the command below:
docker-compose up -d
After the localstack container has successfully uploaded, create the queue in SQS using the make command:
make create-queue
After performing the initial setup, just run the application:
./gradlew run
Your application will be running on localhost:8081
This project has all its endpoints documented in Postman as a shared collection, to get a copy of its endpoints, just click the link below:
TODO
This project is licensed under the MIT License - see the LICENSE file for details.
Thanks and good tests 🎉
