From aed2b8ff35c9bf5a8ca960c937f3c393cd79b44c Mon Sep 17 00:00:00 2001 From: MelvinKim Date: Fri, 17 Mar 2023 11:46:15 +0300 Subject: [PATCH] chore: cleanup Signed-off-by: MelvinKim --- README.md | 44 +++++++++++++++++--------------------------- 1 file changed, 17 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 6fb5547..1d76512 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,27 @@ -myCareHub API -============== +# myCareHub API Field Reporting Database for the mycarehub care delivery projects. ![Linting and Tests](https://github.com/savannahghi/mycarehub-backend/actions/workflows/ci.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/savannahghi/mycarehub-backend/badge.svg?branch=main)](https://coveralls.io/github/savannahghi/mycarehub-backend?branch=main) -Environment variables ---------------------- +## Environment variables In order to work out the environment variables you need to run this project, please examine the main CI workflow file - `.github/workflows/ci.yml`. If a variable is set there, you need it locally too. -Pre-Commit Hooks ------------------ +## Pre-Commit Hooks Code quality checks are run via . You'll have a better experience if you install Pre-Commit and set up the Git hook. -GPG Signing ------------- +## GPG Signing As a contributor, you need to sign your commits: . -Running --------- +## Running In order to serve static assets for local development, you need to set up an `npm` development server: @@ -37,18 +32,16 @@ First, you need to install `npm`. We recommend `nvm`: npm run dev ``` -Settings --------- +## Settings This project was bootstrapped with . The standard settings are documented at . -Setting Up Your Users ---------------------- +## Setting Up Your Users -* To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go. +- To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go. -* To create an **superuser account**, use this command:: +- To create an **superuser account**, use this command:: ```bash > python manage.py createsuperuser @@ -57,18 +50,16 @@ Setting Up Your Users For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users. -Bootstrap ---------- +## Bootstrap The Boostrap CSS is set up for live reloading and SASS compliation. See: -* -* +- +- -Email Server ------------- +## Email Server In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server with a web interface is available as docker container. @@ -77,16 +68,15 @@ Container mailhog will start automatically when you will run all docker containe Please check for more details how to start all containers. With MailHog running, to view messages that are sent by your application, open -your browser and go to ``http://127.0.0.1:8025`` +your browser and go to `http://127.0.0.1:8025` -Deployment ----------- +## Deployment This application is deployed via Google Cloud Build ( ) to Google Cloud Run ( ). There's a `cloudbuild.yaml` file in the home folder. Secrets (e.g production settings) are managed with Google Secret Manager ( ). -Changing OAuth Token Behavior ------------------------------- +## Changing OAuth Token Behavior + The following environment variables are available: ```python