Skip to content

Kayne103/Ngaka473

Repository files navigation

Doctor/Client Management System

forthebadge

Getting Started

For contributors

  • Clone the repo into your machine.
  • Create a branch for every task/issue you'll be working on. Do not push to master, instead make a pull request.
  • Do not hard code secret keys,passwords, and other things that are supposed to be kept private.
  • Follow these standards when writing commit messages.
  • Always mention issue number in your commit messages(if there's any).
  • Ignore cache files, virtual environment directory, IDE settings directory and dotenv file.

Prerequisites

  • Python3.9
  • Django3.2
  • Bootstrap 5
  • dotenv
  • mysqlclient

Installing

  1. Clone the repo into your local machine.
git clone https://github.com/Kayne103/doctorpatientmanagement.git
  1. In the root of the project, Create a virtual environment and activate it.
python3 -m venv venv
source venv/bin/activate (on Ubuntu)

How to create and activate python3 virtual environment

  1. Install requirements
pip3 install -r requirements.txt
  1. Create a .env file.
touch .env
  1. Copy and paste environment variables in the .env file. They will be shared privately.
  2. Make migrations.
python3 manage.py makemigrations
python3 manage.py migrate
  1. Run the project.
python3 manage.py runserver

Raise issues if there's any problem.

Running the tests

Currently, there are no automated tests for this project because initially the requirements were unclear. So it's all free styling until we have an idea of what we are doing.

Deployment

We highly likely to deploy it on Microsoft Azure

Analytics

DeepSource is the way to go. Will be using it to analyze and improve code.

Built With

  • Django - The web framework used

Versioning

We might use SemVer for versioning.

Authors

  • Kaene K. Lebakeng
  • Anesu Banda
  • Bothe Tseme
  • Pearl Rantolo
  • Bokamoso Y. Mogotsi

See also the list of contributors who participated in this project.

License

  • Not yet decided. This project should is only available to the invited parties.