diff --git a/backend/README.md b/backend/README.md index 1187166f4..c5bec92a8 100644 --- a/backend/README.md +++ b/backend/README.md @@ -1,4 +1,4 @@ -# FBA Project - Backend +# FastAPI Best Architecture - Backend ## Docker @@ -21,41 +21,48 @@ 1. Prerequisites - You'll need the following prerequisites: - - Any python version between Python >= 3.10 + - 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 + Clone your forked repository: ```shell - git clone https://github.com//fastapi_best_architecture.git - - cd fastapi_best_architecture/backend - + git clone https://github.com//fastapi_best_architecture.git + ``` + + Go to the root directory of the project, open the terminal, and run the following command: + + ```sh uv sync --frozen ``` -3. Checkout a new branch and make your changes +3. Checkout + + Checkout a new branch and make your changes ```shell - # Checkout a new branch and make your changes git checkout -b your-new-feature-branch ``` -4. Run linting +4. Format and Lint + + Auto-formatting and lint via `pre-commit` ```shell - # Run automated code formatting and linting pre-commit run --all-files ``` -5. Commit and push your changes +5. Commit and push + + Commit your changes and push your branch to the GitHub. + +6. PR - Commit your changes, push your branch to GitHub, and create a pull request. + Create a PR via GitHub ## Scripts