Skip to content

docs: improve local setup instructions #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
FREDPENTA5 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve local setup instructions #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ This is the **recommended** way to run OpenCare-Africa as it ensures consistency
# Copy environment template
cp env.example .env

# Windows (PowerShell):
# Copy-Item env.example .env

# The .env file is already configured for Docker
# No changes needed unless you want to customize settings
```
Expand Down Expand Up @@ -103,7 +106,8 @@ This is the **recommended** way to run OpenCare-Africa as it ensures consistency
curl http://localhost:8000/health/

# Test the web interface
open http://localhost:8000/
# macOS/Linux: open http://localhost:8000/
# Windows: start http://localhost:8000/
```

7. **Access the application**
Expand Down Expand Up @@ -184,6 +188,9 @@ If you prefer to run the application locally without Docker:
# Copy environment template
cp env.example .env

# Windows (PowerShell):
# Copy-Item env.example .env

# Update .env for local development
# Change DB_HOST=localhost and REDIS_HOST=localhost
```
Expand Down Expand Up @@ -222,7 +229,8 @@ If you prefer to run the application locally without Docker:
curl http://localhost:8000/health/

# Test the web interface
open http://localhost:8000/
# macOS/Linux: open http://localhost:8000/
# Windows: start http://localhost:8000/
```

## 📊 API Documentation
Expand Down