Skip to content

Commit

Permalink
Fix typo in contribution description (#456)
Browse files Browse the repository at this point in the history
  • Loading branch information
wu-clan authored Nov 13, 2024
1 parent 87eec41 commit 06cbe56
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- name: Install dependencies
run: |
cd backend
uv sync
uv sync --only-group lint
- name: Run lint
run: |
Expand Down
20 changes: 10 additions & 10 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
## Docker

> [!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
2. Run the following Docker command to build a image:
2. Run the following Docker command to build container:

```shell
docker build -f backend/backend.dockerfile -t fba_backend_independent .
```

3. Start decker image
3. Start container

```shell
docker run -d fba_backend_independent -p 8000:8000 --name fba_app
Expand All @@ -23,30 +23,30 @@
1. Prerequisites

You'll need the following prerequisites:
- Any Python version between Python >= 3.10
- virtualenv or other virtual environment tool
- git
- Any python version between Python >= 3.10
- Git
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
- Fork this repository to your GitHub account
2. Installation and setup
Clone your fork and cd into the repo directory
```shell
# Clone your fork and cd into the repo directory
git clone https://github.com/<your username>/fastapi_best_architecture.git
cd fastapi_best_architecture/backend
vv venv
uv venv
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
# Checkout a new branch and make your changes
git checkout -b your-new-feature-branch
# Make your changes...
```
4. Run linting
Expand Down

0 comments on commit 06cbe56

Please sign in to comment.