Skip to content

Commit

Permalink
readme line separators added
Browse files Browse the repository at this point in the history
  • Loading branch information
miray-mustafov committed Jul 2, 2024
1 parent 67aa2e4 commit 14f1ad2
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Python back-end web application, powered by FastAPI. Designed to implement an e-learning platform where teachers can
easily create courses, and students can enroll in courses based on their subscription tier.
![poodle_intro_img.png](poodle_intro_img.png)

---
## Table of contents

* [Technologies](#technologies-used)
Expand All @@ -13,7 +13,7 @@ easily create courses, and students can enroll in courses based on their subscri
* [Structure](#project-structure)
* [Database](#database)


---
## Technologies Used

**Framework:** FastAPI
Expand All @@ -34,6 +34,7 @@ easily create courses, and students can enroll in courses based on their subscri

**Email Notification:** [Mailjet API](https://dev.mailjet.com/)

---
## Installation and setup

### 1. Clone the project using HTTPS
Expand Down Expand Up @@ -67,10 +68,12 @@ python main.py

Available when you run the server (step 3).

---
## Docker Setup: [Link](https://github.com/delesray/poodle/tree/docker-production?tab=readme-ov-file)

### Setup available at the docker-prod branch documentation

---
## Testing

### To run the tests, navigate to `src/app` and execute the following command
Expand All @@ -79,6 +82,7 @@ Available when you run the server (step 3).
python -m pytest tests
```

---
## Features

- **Public endpoints** - accessible without authentication
Expand All @@ -87,6 +91,7 @@ python -m pytest tests
* Login - available through the *Authorize* button on Swagger
* Get all courses - displays basic information about available courses


- **Authentication Endpoints** (marked with a lock on Swagger) - require login with username and password

- **Features, related to students:**
Expand All @@ -101,7 +106,7 @@ python -m pytest tests
* Subscribe to course
* Unsubscribe from course
* Rate course

- **Features, related to teachers:**
* View account
* Update account
Expand All @@ -128,7 +133,8 @@ python -m pytest tests
* Hide course
* Make student account premium
* Remove student from course


---
## Project Structure

```
Expand All @@ -146,6 +152,7 @@ README.md - project description
requirements.txt - project requirements
```

---
## Database

![Database Schema](db_schema.png)

0 comments on commit 14f1ad2

Please sign in to comment.