☁️ Full Python api RESTful for users and teachers to manage courses. 📖
👉 Features
👉 Author
👉 License
API for managing a course platform, users can be teachers and create their courses with each course having its own sections.
- Create users who can be teachers
- Complete course management created by a teacher
- Complete management of sections of a course
Before you start, you will need to have the following tools installed on your machine:
🐳 Run the containerized api (Docker)
💡 Also, it is good to have an editor to work with the code like VSCode
# Clone the repository
$ git clone <https://github.com/pauloreis7/PythonRoomsApi>
# Install the project dependencies
$ poetry install
# ❗Select python interpreter to venv
# ❗Create envs (.env.example)
# Create database (docker example)
$ docker run --name dev-postgres -e POSTGRES_PASSWORD=c011f0ae -p 5433:5432 -d postgres
# Run the tests
$ pytest -v
# Run the server
$ python .\src\run.py
# The app will start on port defined in PORT env (default 8080)
access <http://localhost:8080>
access docs <http://localhost:8080/docs>
# Clone the repository
$ git clone <https://github.com/pauloreis7/PythonRoomsApi>
# Run the server
$ docker compose up
# The app will start on port defined in PORT env (default 8080)
access <http://localhost:8080>
access docs <http://localhost:8080/docs>
1. Fork the project.
2. Create a new branch with your changes: git 3. checkout -b feature/my-feature
3. Save your changes and create a commit message telling what you have done: git commit -m "feature: My new feature"
4. Submit your changes: git push origin my-feature
Paulo Reis 🏆
Made by Paulo Reis 🤴 Contact me 👋
This project is under the MIT license. See the LICENSE file for more details.🏛️