VctorAHernndez / MPM-backend

Medical Provider Marketplace REST API.

Home Page:https://mpm-django-backend.herokuapp.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Medical Provider Marketplace

This project is a prototype version of a Medical Provider Marketplace where people can find a doctor or other healthcare provider to book an appointment with. Users are able to search the marketplace for providers, see a list of all medical providers, and select a provider to book an appointment with. Inspired on a similar concept called Zocdoc.

Click here for the live demo.

Usage

  1. Clone repository
  2. cd into the cloned folder
  3. Create a virtual environment (python -m venv env)
  4. Activate the virtual environment (source env/bin/activate)
  5. Install requirements (pip install -r requirements)
  6. Create an .env file to store important credentials:
SECRET_KEY=your-secret-key-here
DEBUG=True
  1. Make migrations
  • python manage.py makemigrations api
  • python manage.py migrate
  1. Create app superuser (python manage.py createsuperuser)
  2. Start server (python manage.py runserver)

Alternatively, you can start the server with Heroku CLI using the command heroku local, but make sure to run python manage.py collectstatic first!

For Mac Users

Installation of psycopg2 might be cumbersome if built from source. You might want to check out this post. Alternatively, you might want to simply install the binary itself (already included in requirements.txt as psycopg2-binary).

Additional Notes

If you would like to set it up with a custom PostgreSQL database, you'd have to make changes in .env, setting the DB_USER, DB_NAME, DB_PASSWORD, DB_HOST and DB_PORT variables. Make sure to create the appropriate PostgreSQL roles with login permissions.

Additionally, if you plan on hosting it, set HOST_URL to the host URL (i.e. https://www.example-backend.com).

Finally, if you plan on using a frontend with it, set FRONTEND_APP_URL to the actual origin (i.e. https://www.example-frontend.com).

If used in production, remember to set DEBUG to False.

Progress & Maintenance

The build and maintenance progress is being documented here, for anyone interested.

Acknowledgements

This project was bootstrapped with Django Admin.

About

Medical Provider Marketplace REST API.

https://mpm-django-backend.herokuapp.com


Languages

Language:Python 99.1%Language:Procfile 0.9%