"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/
You'll need to install the following tools
frontend/.nvmrc
sudo apt-get install libpq-dev
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
To get the application running locally on your machine, run the following commands:
# In ./backend/
cargo run # Downloads dependencies, compiles and starts the backend server
# 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
.
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
Until a documentation website is established, you can find some docs for setting up notify & notifications here
See the FAQ here
To contribute, there are several key areas
main
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.
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:
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.
When the changes in your branch are ready:
cargo test
.yarn test
.For further guidance on pull requests and review, see our detailed Code Review guide
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
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.