File tree Expand file tree Collapse file tree 1 file changed +21
-14
lines changed Expand file tree Collapse file tree 1 file changed +21
-14
lines changed Original file line number Diff line number Diff line change 1- # FBA Project - Backend
1+ # FastAPI Best Architecture - Backend
22
33## Docker
44
2121
22221 . Prerequisites
2323
24- You'll need the following prerequisites:
25- - Any python version between Python >= 3.10
24+ - Python >= 3.10
2625 - Git
2726 - [ uv] ( https://docs.astral.sh/uv/getting-started/installation/ )
2827 - Fork this repository to your GitHub account
2928
30292 . Installation and setup
3130
32- Clone your fork and cd into the repo directory
31+ Clone your forked repository:
3332
3433 ``` shell
35- git clone https://github.com/< your username> /fastapi_best_architecture.git
36-
37- cd fastapi_best_architecture/backend
38-
34+ git clone https://github.com/< your account> /fastapi_best_architecture.git
35+ ```
36+
37+ Go to the root directory of the project, open the terminal, and run the following command:
38+
39+ ``` sh
3940 uv sync --frozen
4041 ```
4142
42- 3 . Checkout a new branch and make your changes
43+ 3 . Checkout
44+
45+ Checkout a new branch and make your changes
4346
4447 ``` shell
45- # Checkout a new branch and make your changes
4648 git checkout -b your-new-feature-branch
4749 ```
4850
49- 4 . Run linting
51+ 4 . Format and Lint
52+
53+ Auto-formatting and lint via ` pre-commit `
5054
5155 ``` shell
52- # Run automated code formatting and linting
5356 pre-commit run --all-files
5457 ```
5558
56- 5 . Commit and push your changes
59+ 5 . Commit and push
60+
61+ Commit your changes and push your branch to the GitHub.
62+
63+ 6 . PR
5764
58- Commit your changes, push your branch to GitHub, and create a pull request.
65+ Create a PR via GitHub
5966
6067## Scripts
6168
You can’t perform that action at this time.
0 commit comments