An educational site for children.
The objective of this project was to develop an educational site.
- Context : end of training project.
- Duration : 4 weeks
- Team : 1 backend developer and 3 frontend developers
- Tasks :
- API
- Admin interface
To get a local copy up and running follow these simple steps.
-
Clone this repo to your local machine using
git clone https://github.com/Grandpere/O-Children-API.git
-
Install composer dependencies
composer install
-
Copy .env to .env.local or create one
cp .env .env.local
-
Update DATABASE_URL in this file with your credentials informations
DATABASE_URL=mysql://YOUR_USER:YOUR_PASSWORD@127.0.0.1:3306/YOUR_DBNAME` -
Create database with Doctrine
php bin/console doctrine:database:create
-
Make migrations
php bin/console doctrine:migration:migrate
-
Loading fixtures
php bin/console doctrine:fixtures:load
-
Generate keys for JWT
mkdir -p config/jwt # For Symfony3+, no need of the -p option openssl genrsa -out config/jwt/private.pem -aes256 4096 openssl rsa -pubout -in config/jwt/private.pem -out config/jwt/public.pem -
Configure JWT
⚠️ put your pass_phrase (previous step) in .env.local to be able generate token
See the open issues for a list of proposed features (and known issues).
👷 Add docker for easier installation and prevent missing dependencies
👷 More improvements...
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the LGPL-3.0 License. See LICENSE for more information.