Projet10/README.md
2025-05-22 21:53:56 +02:00

70 lines
1015 B
Markdown

# OCR / DA Python - Project10
## SoftDesk
Build a REST API using DjangoRestFramework
- users, authors, contributors
- projects/issues/comments
-> data models, user model, relations
-> authentication
### Introduction
These instructions allow you to :
- get the program
- install the required environment
- run and use it
### Requirements
1. modules
```
packages : python 3.11, python3.11-venv, python3-pip, git
```
### Installation
1. Clone this repo and go in the project's directory
2. Create the virtual environment
```
python3.11 -m venv env
source env/bin/activate
```
3. install environment
```
pip install -r requirements.txt
```
## Execution
1. Go in the Django project directory
```
cd softdesk
```
2. Initialize the database
```
python manage.py migrate
```
3. Launch the test's server
```
python manage.py runserver
```
## Use
URL is : http://127.0.0.1:8000
Endpoints and methods are coming soon
## Author
YaL <yann@needsome.coffee>
## License
MIT License
Copyright (c) 2025