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 want to go eat out or order from.
This repository is part of the Good Food Tracker
project and is used for the development of the backend system.
For the list of existing or currently being developed feature please refer to the features section of this document.
To get started on development follow these steps:
.env.example
to .env
;
.env
file;docker-compose up
;postgres
database;
pgAdmin
web UI;
pgAdmin
web UI can be accessed at: localhost:${PGADMIN_PORT}
;${PGADMIN_DEFAULT_EMAIL}
and ${DB_PASSWORD}
gft-postgres
${DB_PORT}
${DB}
${DB_USERNAME}
${DB_PASSWORD}
.migration.example.config
into .migration.config
;
.migration.config
file;docker-compose exec app php ./cli/migrate.php --init
to initialize the migrations table;docker-compose exec app php ./cli/migrate.php --up
to run all the migrations;docker-compose exec app composer install
to install php dependencieslocalhost:${APACHE_PORT}
to see if everything is working;List of currently completed or still being developed feature:
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.
Thanks go to these wonderful people (emoji key):
negue π€ |
Subham Sahu π» |
Kate Bartolo π |
Rajakavitha1 π |
skrrra π» |
Ishan Vyas π» |
Abilogos π π π» |
This project follows the all-contributors specification. Contributions of any kind welcome!