Skip to content

Commit e7745a3

Browse files
committed
docs: improved readme setup instructions
1 parent 29fefda commit e7745a3

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ venv: ## Create a virtual environment
3939
install: ## Install development dependencies
4040
$(PIP) install --upgrade pip
4141
$(PIP) install -r requirements.txt
42+
$(PIP) install pre-commit==3.7.1
4243
$(PRE_COMMIT) install
4344
cp .env.example .env
4445
@echo "Development dependencies has been setup."
@@ -58,6 +59,7 @@ clean: ## Clean up the project of unneeded files
5859
@echo "Cleaning up the project of unneeded files..."
5960
@rm -rf $(VENV_DIR)
6061
@rm -rf .cache
62+
@rm -rf build
6163
@rm -rf htmlcov coverage.xml .coverage
6264
@rm -rf .tox
6365
@rm -rf .mypy_cache

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Before you begin, the project assumes the following:
1010
- Python 3.10 or later installed.
1111
- PostgreSQL installed.
1212

13-
A Makefile has been provided for easy project setup. You can run the command `make` to see all available commands.
13+
A Makefile has been provided for easy project setup.
1414

1515
## Setup Instructions
1616

@@ -26,7 +26,7 @@ A Makefile has been provided for easy project setup. You can run the command `ma
2626
cd fastapi_web
2727
```
2828

29-
- **Create and Activate the Virtual Environment**
29+
- **Create a Virtual Environment**
3030

3131
```bash
3232
make venv
@@ -48,12 +48,6 @@ A Makefile has been provided for easy project setup. You can run the command `ma
4848

4949
This command will copy an `.env` file into your directory. Open it and update the values before you proceed.
5050

51-
- **Run Database Migrations**
52-
53-
```bash
54-
make migrate
55-
```
56-
5751
- **Run Checks**
5852

5953
Ensure that everything is set up correctly:
@@ -80,6 +74,8 @@ A Makefile has been provided for easy project setup. You can run the command `ma
8074
make clean
8175
```
8276

77+
You can run the command `make` to see all available commands.
78+
8379
## Credits
8480

8581
- [HNG Boilerplate](https://github.com/hngprojects/hng_boilerplate_python_fastapi_web)

0 commit comments

Comments
 (0)