mirror of
https://github.com/fastapi-practices/fastapi-best-architecture.git
synced 2026-09-21 13:12:24 +00:00
Fix typo in contribution description (#456)
This commit is contained in:
@@ -26,7 +26,7 @@ jobs:
|
|||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: |
|
||||||
cd backend
|
cd backend
|
||||||
uv sync
|
uv sync --only-group lint
|
||||||
|
|
||||||
- name: Run lint
|
- name: Run lint
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
+10
-10
@@ -3,16 +3,16 @@
|
|||||||
## Docker
|
## Docker
|
||||||
|
|
||||||
> [!IMPORTANT]
|
> [!IMPORTANT]
|
||||||
> Due to Docker context limitations, you cannot successfully build a image using a Dockerfile in the current directory
|
> Due to Docker context limitations, you can't build an image in this directory
|
||||||
|
|
||||||
1. Make sure you're at the root of the project
|
1. Make sure you're at the root of the project
|
||||||
2. Run the following Docker command to build a image:
|
2. Run the following Docker command to build container:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker build -f backend/backend.dockerfile -t fba_backend_independent .
|
docker build -f backend/backend.dockerfile -t fba_backend_independent .
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Start decker image
|
3. Start container
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker run -d fba_backend_independent -p 8000:8000 --name fba_app
|
docker run -d fba_backend_independent -p 8000:8000 --name fba_app
|
||||||
@@ -23,30 +23,30 @@
|
|||||||
1. Prerequisites
|
1. Prerequisites
|
||||||
|
|
||||||
You'll need the following prerequisites:
|
You'll need the following prerequisites:
|
||||||
- Any Python version between Python >= 3.10
|
- Any python version between Python >= 3.10
|
||||||
- virtualenv or other virtual environment tool
|
- Git
|
||||||
- git
|
|
||||||
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
|
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
|
||||||
|
- Fork this repository to your GitHub account
|
||||||
|
|
||||||
2. Installation and setup
|
2. Installation and setup
|
||||||
|
|
||||||
|
Clone your fork and cd into the repo directory
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# Clone your fork and cd into the repo directory
|
|
||||||
git clone https://github.com/<your username>/fastapi_best_architecture.git
|
git clone https://github.com/<your username>/fastapi_best_architecture.git
|
||||||
|
|
||||||
cd fastapi_best_architecture/backend
|
cd fastapi_best_architecture/backend
|
||||||
|
|
||||||
vv venv
|
uv venv
|
||||||
|
|
||||||
uv pip install -r requirements.txt
|
uv pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Check out a new branch and make your changes
|
3. Checkout a new branch and make your changes
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
# Checkout a new branch and make your changes
|
# Checkout a new branch and make your changes
|
||||||
git checkout -b your-new-feature-branch
|
git checkout -b your-new-feature-branch
|
||||||
# Make your changes...
|
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Run linting
|
4. Run linting
|
||||||
|
|||||||
Reference in New Issue
Block a user