Skip to content

docs: improve README with setup and usage instructions #28

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
El-Fati wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README with setup and usage instructions #28

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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# OpenCare-Africa
# OpenCare-cora

A comprehensive health informatics platform backend built with Django, designed specifically for healthcare management in Africa.

## 🏥 Project Overview

OpenCare-Africa is a robust, scalable backend system for managing healthcare operations, patient records, health worker management, and health facility operations. The system is built with modern Django practices and includes comprehensive API endpoints for integration with frontend applications.
OpenCare-caore is a robust, scalable backend system for managing healthcare operations, patient records, health worker management, and health facility operations. The system is built with modern Django practices and includes comprehensive API endpoints for integration with frontend applications.

## ✨ Features

Expand Down Expand Up @@ -58,12 +58,12 @@ OpenCare-Africa/

### 🐳 Docker Setup (Recommended)

This is the **recommended** way to run OpenCare-Africa as it ensures consistency across all environments.
This is the **recommended** way to run OpenCare-core as it ensures consistency across all environments.

1. **Clone the repository**
```bash
git clone https://github.com/bos-com/OpenCare-Africa.git
cd OpenCare-Africa
git clone https://github.com/El-Fati/OpenCare-core.git
cd OpenCare-core
```

2. **Set up environment variables**
Expand Down Expand Up @@ -163,8 +163,8 @@ If you prefer to run the application locally without Docker:

1. **Clone the repository**
```bash
git clone https://github.com/bos-com/OpenCare-Africa.git
cd OpenCare-Africa
git clone https://github.com/El-Fati/OpenCare-core.git
cd OpenCare-core
```

2. **Set up Python virtual environment**
Expand Down