Skip to content

Latest commit

 

History

History
131 lines (80 loc) · 4.93 KB

README.md

File metadata and controls

131 lines (80 loc) · 4.93 KB
Raw

Notify

"Notify" is a multi channel notification scheduling tool.

To read more about what it does and how to use it, visit our documentation site: https://docs.msupply.foundation/notify/introduction/

Setup

You'll need to install the following tools

Linux

  • For Ubuntu:
  sudo apt-get install libpq-dev

Mac

  • For M1 Mac:

brew install libpq and add the following to ~/.cargo/config.toml

[env]
MACOSX_DEPLOYMENT_TARGET = "10.7"

[target.aarch64-apple-darwin]
rustflags = "-L /opt/homebrew/opt/libpq/lib"

You may also need to run brew link --force libpq

Running Notify locally

To get the application running locally on your machine, run the following commands:

1. Build and start the backend

# In ./backend/
cargo run # Downloads dependencies, compiles and starts the backend server

2. Build the frontend

# In ./frontend/
nvm use # To use the node version specified in .nvmrc
yarn # Downloads dependencies

yarn start # Transpiles the frontend artifacts to default location for backend server to serve

All going well, this should open the web app and login page in your default browser. If running for the first time (or you've deleted the database) the database will be initialised with a user to login with username: admin, password: pass.

Development

Find further details about frontend and backend development in the respective README.md files:

After setting up your environment, There are some quick start tutorials you can follow here

Docs for setting up notifications

Until a documentation website is established, you can find some docs for setting up notify & notifications here

Frequently Asked Questions

See the FAQ here

Contributing

To contribute, there are several key areas

  1. Create issues for bugs or improvements to the system.
  2. Taking on issues from our triaged list of issues. Please ask the team!
  3. Create a pull request for your changes into the branch main
  4. Review PRs of others ❤️

Issues

Please use our issue templates. They help by providing a concise framework for including the minimum useful amount of information and some default labeling.

If working on an issue, assign yourself to the issue. Not doing so risks multiple people working on the same problem.

Branching

For now, we only have a main branch that get active development merged into it. In the future we may move to the below branching strategy to match other mSupply product workflows.

Our goal is to achieve something inspired by gitflow (also a good link). We have 2 protected branches:

  • main is considered the stable, production ready branch. It may receive hotfixes.
  • develop is where features and non-critical fixes are merged into.

When working on an issue you should create a branch on which you'll commit the changes you are making. Including the issue number in your branch name helps us identify which issue a particular branch relates to:

X-fixes-thing-being-fixed, where X is the issue number.

Pull Requests

When the changes in your branch are ready:

  1. Ensure backend tests pass by running cargo test.
  2. Ensure frontend tests pass by running yarn test.
  3. Make a pull request into the branch develop. Another person must review your changes by sanity checking the code and solution, and ideally give it a quick test in a dev environment.
  4. Once approved, a reviewer might merge immediately or leave for you to merge (if sufficient permissions) if there are some optional suggestions to consider.

For further guidance on pull requests and review, see our detailed Code Review guide

Release

When a set of changes in develop are considered stable, we'll merge develop into main and create a tag marking the release.

TMF staff can publish the change using the documentation in our wiki

Key Design Decisions (KDD)

Important Design Decisions for this project will be documented in the repository in docs/decisions. The approach is similar to the design decision log from Microsoft.