Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AliMortezaei authored Feb 17, 2024
1 parent e733255 commit 529f1ed
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,34 @@
# ParvazAcademy
## :iphone: a platform for learning
#### with three different roles: student, teacher, admin
# :monocle_face: Specification:
# :monocle_face: Introduction:
- Teacher and admin can define and manage a course (teacher can only manage the course he createdr)
- A student can join a course
- Each course can have several sections
- Anyone can see the courses
- Teacher and student can manage their own profile
- Authentication with phone number and email .......
# Tools and Features
- **dependency management poetry -v 1.7**
- **using library celery for asynchronous tasks**
- **using redis for storage data and message broker**
- **using database postgresql**
- **using boto3 for arvancloud storage**
- **using JWT(JSON Web Token) for authentication**
- **using Amazon S3 for Media storage **
- **using JWT(JSON Web Token) for authentication**
- **using Gunicorn to run wsgi server**
- **writing testing project**
- **writing documents project**
- **workflow github action** for tesing project, build docker container added dockerhub ([repository](https://hub.docker.com/r/mortezaei2/parvaz_academy))
- **dockerize project(using docker compose)**
# Run Project
- Clone project
```bash
git clone https://github.com/AliMortezaei/ParvazAcademy.git
```
- Edit the .env file and specify the environment variables that are required
- Run via docker compose
```bash
docker compose up -d --build
```
- go to browser localhost 0.0.0.0:8000
- Go to browser localhost 0.0.0.0:8000

0 comments on commit 529f1ed

Please sign in to comment.