MyFood is a platform that allows users to explore trending foods and rate their favorites, creating a dynamic food ranking system.
Project Name: MyFood 🍔🍕🌭
Development Start Date: 03/02/2024 ⏩
Development End Date: 11/03/2024 🏁
Status: Completed ✅
Technologies used: ☕ Spring Boot | 🍃 MongoDB | 🚈 Railway | 🪂 Swagger | 🟣 Insomnia
🚈 Railway Deploy Link: MyFood Deploy
🪂 Swagger Link: MyFood Swagger
🟣 Insomnia Import File Link: MyFood Insomnia
MyFood is a fictional app that implements a ranking system. The purpose of this project is to showcase the most searched foods and their associated scores within the fictitious app named MyFood.
- Implementation of a food ranking system.
- Display of most searched foods.
- Integration with MongoDB for data storage.
Please note that MongoDB or Railway services may be temporarily unavailable due to inactivity or other technical reasons. If this happens, you may need to clone the repository to your local machine and connect to another MongoDB database.
Clone the repository:
git clone https://github.com/LadyJessie19/MyFood.git
To start the application:
- Navigate to the project directory.
- Run the following command to build and start the application:
mvn spring-boot:run
This will start the application on the default port, typically 8080
. For development purposes, I used the port 8081
.
- Download the Insomnia file;
- Open Insomnia;
- Import the File:
- Click on the
Import/Export
button in the top-right corner of the Insomnia window. - Select
Import Data
from the dropdown menu. - Choose
From File
and browse to the location where you downloaded the Insomnia file. - Select the file and click
Open
to import it.
- Click on the
- Start Testing;
Once imported, you will see the collection of pre-configured requests in Insomnia. You can now start using them to test MyFood API.
Note: Make sure to set up the environment variable
base_url
. If you're running the project locally the default value ishttp://localhost:8080
, but if you're running the project on Railway the default value ishttps://app-myfood-production.up.railway.app
.
- Developer: Jessie M Bentes
If you want to contribute to the project, follow these steps:
- Fork the project.
- Create a new branch (
git checkout -b feature/new-feature
). - Commit your changes (
git commit -am 'Add new feature'
). - Push to the branch (
git push origin feature/new-feature
). - Create a new Pull Request.
This project is licensed under the MIT License.