README.md

Pharmanathi.com

Welcome to Pharmanathi.com.

This is the repo containing all development resources for the Pharmanthi.com project; backend and front-end clients. From a bird's eye view, the repo is organised as follows:

├── mobile_mhp      -- Medical Health Professional Flutter project.
├── mobile_patient  -- Patient app, a flutter project
└── pharmanathi.com -- Pharmanathi.com backend, a Django-based project

Getting Started (General)

Clone this repository on your local and before doing anything else, ensure you can successfully run the command used to setup Git hooks required to contribute to this project. You may skip this step if you do not intend on contributing to this repo:

cd pharmanathi.com # or whatever folder name you used
chmod +x setup_hooks
./setup_hooks

Specific steps for each sub-repo

Each inner project may present it's own requried setup, so make sure to read their related README file. You may find them using the following links which points to their location in their respective project's folder:

• Patient Mobile Client's README
• MHP Mobile Client's README
• Backend's README

Contribution Guidelines

We follow the Angular commit convention of which some reading materials can be found on the following links:

• Conventional Commits
• Commit Message Format

We use the same convention to label tickets on GitHub.

Project Management

The project's various boards are avaiblable here as GitHub projects(v2). The initial project is mvp-v-2.0. anathi/projects/5).