Skip to content

Additional notes on Notify README #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Additional notes on Notify README #299

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d3357e2
Update README.md with step to include Telegram configuration
rfromthecastle Apr 11, 2025
3585816
Update README.md with note to clone the repo.
rfromthecastle Apr 11, 2025
81b1c56
Update README.md to add step on navigating into cloned repo
rfromthecastle Apr 11, 2025
52670ef
Update README.md to add note on existing PostgreSQL database
rfromthecastle Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ You'll need to install the following tools
- Or install [node.js](https://nodejs.org/), preferably the version in `frontend/.nvmrc`
- [Yarn](https://yarnpkg.com/getting-started/install)

Clone this repository to a location on your local disk.

You'll also need to create a Telegram bot and configure the token in `configuration/local.yaml`. Please follow the instructions in [this](https://github.com/msupply-foundation/notify/edit/main/backend/README.md) document.

If you already have an existing local PostgreSQL database named 'dashboard' (e.g., from local mSupply dashboard setup), make sure you configure the correct username and password to access this database in `configuration/local.yaml`.

### Linux

- For Ubuntu:
Expand Down Expand Up @@ -42,7 +48,7 @@ You may also need to run

## Running Notify locally

To get the application running locally on your machine, run the following commands:
To get the application running locally on your machine, navigate into the cloned repository using a terminal and run the following commands:

### 1. Build and start the backend

Expand Down