RESTful API for Epic Events
This project provide a RESTful API localy.
Allow developper to create the front-end.
Those instructions will bring you the API at the url : http://127.0.0.1:8000/.
Before started to setup the RESTful API, you need to get :
- Python >= 3.6
- Postman
- Git
- PostgreSQL
It will provide you tools to extract, run and detail the API.
- Create a folder
- Clone the project
git cloneinside the folder - Go to the folder OCR_P12
cd OCR_P12 - Create environment named env
python -m venv env - Start the environment
env\Scripts\activate.bat - Install requirements
pip install -r requirements.txt - Run server
python CRM/manage.py runserver
If you want to check the PEP8 from the code :
- From OCR_P12 go to CRM
cd CRM - run
flake8
For potential future updates, tests have been made.
To launch tests :
- from OCR/P12, change branch -> tests :
git checkout tests - Instead of running server
python CRM/manage.py test - When tests are done, switch bach to main :
git checkout main
Once you ran the server, you can check those endpoints and get documentation on them from the Postman API Documentation.
The collection : Postman API Collection.
- Python - Programming language
- Django - Website Framework
- Django REST Framework - REST Framework for Django (DRF)
- Django REST Framework simple JWT - JWT Authentification backend for DRF
- PostgreSQL - Database
- Postman - API Development
- @Emericdefay - Work
- @OpenClassRoom - Project