Good Food Tracker

Good food tracker project is a collection of a back end web API (Nodejs & Express), front end web app (Vuejs) and a mobile application (Kotlin).

The project aims to allow the users to take pictures and/or leave notes, ratings, comments about restaurants they visit in order to be able to reference it later when they try to pick were they wanna go eat out or order from.

What is this repository for?

This repository is for the back end API built with Nodejs & Express

For the list of existing or currently being developed feature please refer to the features section of this document.

How do I get set up?

To get started on development follow these steps:

• Rename .env.example to .env;
  • Add your values to the .env file;
• Run npm install;
• Create MySQL database;
  • Run db-migrate up to run all database migrations;
• To start the dev version of the server run: npm run dev;
• Visit localhost:3000 to see if everything works;

Contribution guidelines

• Keep code clean and simple;
• DO NOT alter the database directly, use migrations;
• Always use branches and pull requests when making changes to the codebase;

Who do I talk to?

• If you have any question you can contact Igor Ilić via e-mail or twitter
• If you have found a bug or want to ask for a new feature, open a new issue

Features

List of currently completed or still being developed feature:

• Login
• Register
• User profile
  • Get user profile information
  • Update user profile information
  • Delete user profile
• Restaurants
  • List of all the restaurants
  • Add / edit restaurant
  • Delete restaurant
• City
  • List of cities
  • Add / edit city
  • Delete city
• Country
  • List of countries
  • Add / edit country
  • Delete country
• Reviews
  • List of users reviews
  • Add / edit your review
    • Add / remove image for a review
  • Delete your own review

Notes

Database diagram with current, future and optional tables can be found on dbDiagram.io.

Possible future tables in the database diagram will be positioned on the right side of the diagram. Whereas the existing ones or the ones that are being worked on are positioned on the left side.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

negue 🤔

Subham Sahu 💻

Kate Bartolo 📖

This project follows the all-contributors specification. Contributions of any kind welcome!