Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,20 @@ Welcome to the documentation for the FastAPI Beyond CRUD course.
This repository contains the source code for the course website.

## Prerequisites

Before starting, make sure you have the following installed:

- Python 3.10+
- Git
- pip

### Verify Installation

```bash
python --version
git --version
pip --version
```

## Project Setup
To set up the project, follow these steps:
Expand Down Expand Up @@ -56,6 +67,7 @@ Click the **Fork** button at the top-right corner of the repository page on GitH
```bash
venv\Scripts\activate
```
> After activation, you should see `(venv)` in your terminal.

6. **Install the required dependencies:**
```bash
Expand All @@ -66,6 +78,8 @@ Click the **Fork** button at the top-right corner of the repository page on GitH
```bash
mkdocs serve
```
### Open in Browser

Once the server starts successfully, open your browser and visit:

```text
Expand All @@ -89,3 +103,30 @@ fastapi-beyond-crud-docs/
```

---
## Contributing

Contributions are welcome.

Follow these steps:

1. Fork the repository
2. Create a new branch

```bash
git checkout -b feature-name
```

3. Make your changes
4. Commit your changes

```bash
git commit -m "Added new feature"
```

5. Push your changes

```bash
git push origin feature-name
```

6. Create a Pull Request