README.md

Montessori-Ressources web app

This is the git repository of the Montessori Ressources webapp. It is a Symfony webapp designed to help Montessori community finding the right tool.

How to develop on this project ?

If you want to help PR and issues are welcome !

You need to have php and composer (https://getcomposer.org) on your computer.

First you need to install the needed dependencies :

composer install

By default you can develop on SQLite db, it comes with no prerequisites. If you want to test mysql then you have to create a .env.local file (do not commit!) with the following content:

DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name"

and change db_user db_password db_name with correct values for you.

Then you can init the database:

bin/console doctrine:migrations:migrate

Populate with fake data (faker formaters here):

bin/console doctrine:fixture:load

Then you can start the local webserver and go on http://localhost:8000 !

bin/console server:run

Translations

This project is using the translation module of Symfony (doc here). The template is written in english and we want to have a french translation.

Modify data model

You can just modify src/Entity/* classes to edit the data model and links. Symfony provide a tool named doctrine:schema:update but we prefer on this project to use doctrine:migrations:migrate (it is safer)

After your modification create your migration file:

bin/console make:migration

It will make the migration file.

Then apply the migration files on your database:

bin/console doctrine:migrations:migrate

Test

Run:

bin/phpunit

A CI test build is launched automatically by Travis-CI at each commit.

Deploy

Deploy on integration system

This app is setup to automatically deploy the develop branch on a Heroku application, using Travis CI. The setup is described here.

If you want to manually deploy on Heroku a specific branch (my-specific-branch) you can do that by the following commands:

heroku git:remote -a heroku-app-name # add the heroku remote
git push heroku my-local-branch:master # push

Deploy on prod

This app is setup to automatically deploy the master branch on the prod system, using Travis CI. The setup is using the file deploy.sh that is triggering all the needed actions (git checkout then composer install).

Licence

This project is licensed under the MIT License - see the LICENSE.md file for details

Thanks

TODO