File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -14,9 +14,20 @@ Welcome to the documentation for the FastAPI Beyond CRUD course.
1414This repository contains the source code for the course website.
1515
1616## Prerequisites
17+
1718Before starting, make sure you have the following installed:
1819
1920- Python 3.10+
21+ - Git
22+ - pip
23+
24+ ### Verify Installation
25+
26+ ``` bash
27+ python --version
28+ git --version
29+ pip --version
30+ ```
2031
2132## Project Setup
2233To set up the project, follow these steps:
@@ -56,6 +67,7 @@ Click the **Fork** button at the top-right corner of the repository page on GitH
5667 ` ` ` bash
5768 venv\S cripts\a ctivate
5869 ` ` `
70+ > After activation, you should see ` (venv)` in your terminal.
5971
60726. ** Install the required dependencies:**
6173 ` ` ` bash
@@ -66,6 +78,8 @@ Click the **Fork** button at the top-right corner of the repository page on GitH
6678 ` ` ` bash
6779 mkdocs serve
6880 ` ` `
81+ # ## Open in Browser
82+
6983 Once the server starts successfully, open your browser and visit:
7084
7185 ` ` ` text
@@ -89,3 +103,30 @@ fastapi-beyond-crud-docs/
89103` ` `
90104
91105---
106+ # # Contributing
107+
108+ Contributions are welcome.
109+
110+ Follow these steps:
111+
112+ 1. Fork the repository
113+ 2. Create a new branch
114+
115+ ` ` ` bash
116+ git checkout -b feature-name
117+ ` ` `
118+
119+ 3. Make your changes
120+ 4. Commit your changes
121+
122+ ` ` ` bash
123+ git commit -m " Added new feature"
124+ ` ` `
125+
126+ 5. Push your changes
127+
128+ ` ` ` bash
129+ git push origin feature-name
130+ ` ` `
131+
132+ 6. Create a Pull Request
You can’t perform that action at this time.
0 commit comments