docs: updated readme with setup instructions

Author: Pythonian

Makefile

@@ -3,7 +3,7 @@
 .DEFAULT_GOAL=help
 
 # Define commands to be explicitly invoked
-.PHONY: all venv install check clean help run migrate hello
+.PHONY: help hello venv install migrate check run clean
 
 # Define the name of the virtual environment directory
 VENV_DIR = .venv
@@ -26,28 +26,34 @@ UVICORN = $(VENV_DIR)/bin/uvicorn
 # Define the alembic executable within the virtual environment
 ALEMBIC = $(VENV_DIR)/bin/alembic
 
+help: ## Show this help
+	@egrep -h '\s##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
 hello: ## Hello, World!
 	@echo "Hello, World!"
 
-# Setup the development environment
-all: venv install check
-
 venv: ## Create a virtual environment
 	$(PYTHON) -m venv $(VENV_DIR)
 	@echo "Virtual environment created."
 
-install: ## Install development packages
+install: ## Install development dependencies
 	$(PIP) install --upgrade pip
 	$(PIP) install -r requirements.txt
 	$(PRE_COMMIT) install
 	cp .env.example .env
-	@echo "Development packages has been setup."
+	@echo "Development dependencies has been setup."
+
+migrate: ## Run the database migration
+	$(ALEMBIC) upgrade head
 
 check: ## Run all checks using tox and pre-commit
 	$(TOX)
 	$(PRE_COMMIT) run --all-files
 	@echo "All checks passed"
 
+run: ## Run the development server
+	$(UVICORN) main:app --reload
+
 clean: ## Clean up the project of unneeded files
 	@echo "Cleaning up the project of unneeded files..."
 	@rm -rf $(VENV_DIR)
@@ -61,13 +67,3 @@ clean: ## Clean up the project of unneeded files
 	@find . -name "*.pyc" -delete
 	@find . -type d -name "__pycache__" -exec rm -r {} +
 	@echo "Clean up successfully completed."
-
-help: ## Show this help
-	@egrep -h '\s##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
-
-run: ## Run the development server
-	$(UVICORN) main:app --reload
-
-migrate: ## Run the database migration
-	$(ALEMBIC) revision --autogenerate
-	$(ALEMBIC) upgrade head

README.md

@@ -1,3 +1,86 @@
-# FastAPI Blog
+# FastAPI Project
 
-FastAPI boilerplate setup
+Welcome to the FastAPI project! Follow these instructions to set up the project on your local machine and get everything running smoothly.
+
+## Prerequisites
+
+Before you begin, the project assumes the following:
+
+- A Linux environment, or WSL (if using Windows)
+- Python 3.10 or later installed.
+- PostgreSQL installed.
+
+A Makefile has been provided for easy project setup. You can run the command `make` to see all available commands.
+
+## Setup Instructions
+
+- **Clone the Repository**
+
+   ```bash
+   git clone https://github.com/Pythonian/fastapi_web.git
+   ```
+
+- Change into the cloned repository
+
+   ```bash
+   cd fastapi_web
+   ```
+
+- **Create and Activate the Virtual Environment**
+
+   ```bash
+   make venv
+   ```
+
+   Activate the virtual environment with the command:
+
+   ```bash
+   source .venv/bin/activate
+   ```
+
+   *Ensure the virtual environment is activated before running any further commands.*
+
+- **Install Dependencies**
+
+   ```bash
+   make install
+   ```
+
+   This command will copy an `.env` file into your directory. Open it and update the values before you proceed.
+
+- **Run Database Migrations**
+
+   ```bash
+   make migrate
+   ```
+
+- **Run Checks**
+
+   Ensure that everything is set up correctly:
+
+   ```bash
+   make check
+   ```
+
+- **Run the Development Server**
+
+   To start the development server, use:
+
+   ```bash
+   make run
+   ```
+
+   You can then view the API docs at `http://127.0.0.1:8000/docs/`.
+
+- **Cleaning Up**
+
+   To clean up the project directory, removing unnecessary files and directories, use:
+
+   ```bash
+   make clean
+   ```
+
+## Credits
+
+- [HNG Boilerplate](https://github.com/hngprojects/hng_boilerplate_python_fastapi_web)
+- [FastAPI Tutorial](https://www.youtube.com/playlist?list=PLEt8Tae2spYnHy378vMlPH--87cfeh33P)