File tree 1 file changed +21
-14
lines changed
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
2
2
3
3
## Docker
4
4
21
21
22
22
1 . Prerequisites
23
23
24
- You'll need the following prerequisites:
25
- - Any python version between Python >= 3.10
24
+ - Python >= 3.10
26
25
- Git
27
26
- [ uv] ( https://docs.astral.sh/uv/getting-started/installation/ )
28
27
- Fork this repository to your GitHub account
29
28
30
29
2 . Installation and setup
31
30
32
- Clone your fork and cd into the repo directory
31
+ Clone your forked repository:
33
32
34
33
``` 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
39
40
uv sync --frozen
40
41
```
41
42
42
- 3 . Checkout a new branch and make your changes
43
+ 3 . Checkout
44
+
45
+ Checkout a new branch and make your changes
43
46
44
47
``` shell
45
- # Checkout a new branch and make your changes
46
48
git checkout -b your-new-feature-branch
47
49
```
48
50
49
- 4 . Run linting
51
+ 4 . Format and Lint
52
+
53
+ Auto-formatting and lint via ` pre-commit `
50
54
51
55
``` shell
52
- # Run automated code formatting and linting
53
56
pre-commit run --all-files
54
57
```
55
58
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
57
64
58
- Commit your changes, push your branch to GitHub, and create a pull request.
65
+ Create a PR via GitHub
59
66
60
67
## Scripts
61
68
You can’t perform that action at this time.
0 commit comments