-
Notifications
You must be signed in to change notification settings - Fork 110
Quickstart
It is possible to download, build and run the entire CBS system under Docker. This can be done on Windows, Mac and Linux.
Note: Windows Home edition will not run docker. It is still possible to run MongoDB Community Server as well as the frontends and backends outside of docker.
Note II: It is not always necessary or even recommended to run the entire CBS system. Often a developer will only need to run the single Bounded Context they are currently working on. Jump to Development on a Bounded Context
Windows: https://git-scm.com/downloads
linux (ubuntu):
sudo apt install git
Mac (OSX 10.9 and above):
git --version (and follow the prompts)
Windows/Mac: https://nodejs.org/
linux
sudo apt install nodejs
npm install npm@latest -g
npm install -g typescript
npm install -g @angular/cli@latest
Windows: https://hub.docker.com/editions/community/docker-ce-desktop-windows
linux (ubuntu):
sudo apt install docker.io
sudo apt install docker-compose
Mac:
https://hub.docker.com/editions/community/docker-ce-desktop-mac
https://dotnet.microsoft.com/download/dotnet-core/2.2
git clone https://github.com/IFRCGo/cbs
To start up the CBS app with all frontends, backends and MongoDB, all running as docker containers, from the cbs/Deploy/Compose/ folder, run:
Windows:
all-build.cmd
all-up.cmd
Linux/Mac:
./all-build.sh
./all-up.sh
Note: all-up will build if build has not yet been done. The build can take 10 minutes or more.
Note II: If you make changes to code, you need to re-run all-build followed by all-up for the code to be reflected in the runtime environment.
The solution should now be available at http://localhost:8080
You can see the docker containers by running
docker ps
The docker containers will run until they are stopped.
Windows: all-down.cmd
Mac/Linux: all-down.sh
Shortcut to pull latest code, build and deploy (Mac/Linux)
git pull && ./all-build.sh && ./all-up.sh
-
Try "sending" an SMS using the Case Report format by going to http://localhost:8080/notifications/
-
This SMS should then appear on the Case Reports page at http://localhost:8080/reporting/case-report/list/all
- Learn more about CBS on the project website
- [Set up your development environment]
- Learn more about [UI development]
- Learn more about [Backend development]
- Learn more about the [Bounded contexts] in the system
- Dive into the [doLittle architectural framework] in use
- Look at the open github issues