README.md

O'Children (Backend & API)

An educational site for children.

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

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 :
  1. API
  2. Admin interface

Built With

• Symfony 4
• Bootstrap
• Doctrine
• Twig
• JWT
• NelmioApiDoc

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• composer

Installation

1. Clone this repo to your local machine using

   git clone https://github.com/Grandpere/O-Children-API.git

2. Install composer dependencies

   composer install

3. Copy .env to .env.local or create one

   cp .env .env.local

4. Update DATABASE_URL in this file with your credentials informations

   DATABASE_URL=mysql://YOUR_USER:YOUR_PASSWORD@127.0.0.1:3306/YOUR_DBNAME`
   

5. Create database with Doctrine

   php bin/console doctrine:database:create

6. Make migrations

   php bin/console doctrine:migration:migrate

7. Loading fixtures

   php bin/console doctrine:fixtures:load

8. 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

   More information

9. Configure JWT

   ⚠️ put your pass_phrase (previous step) in .env.local to be able generate token

   More information

Roadmap

See the open issues for a list of proposed features (and known issues).

👷 Add docker for easier installation and prevent missing dependencies
👷 More improvements...

Contributing

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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the LGPL-3.0 License. See LICENSE for more information.

Contact

@LMarozzo

https://github.com/Grandpere/O-Children-API

Acknowledgements

• O'Clock
• Mathieu (project's frontend team)

Frontend repository

Frontend repository