Scrumble is an app we use at M33 to perform faster daily Scrum tasks:
It is connected to your Trello board and GoogleApps account and helps to:
- Update your burndown chart
- Send daily reports to your client (what is a daily report?)
- Fill Satisfaction survey
- Track your problems and actions
Requisites
The easiest way to develop on Scrumble is to:
Make sure your Docker installation is working fine by typing docker ps
.
Clone the Project
git clone [email protected]:theodo/scrumble.git && cd scrumble
Specify environment variables in .env file
cp .env.example .env
Launch the installation
make install
Launch the project
make start
The project will be available at https://0.0.0.0:9876/
If the app is stuck in the loading screen (with the Scrumble logo), go to this file :
client/src/login/config/trello.coffee
and edit the following line :
.config (TrelloApiProvider, API_URL, TRELLO_KEY) ->
to remove the TRELLO_KEY
parameter. You should have this :
angular.module 'Scrumble.login'
.config (TrelloApiProvider, API_URL) ->
TrelloApiProvider.init
key: "YOUR_KEY"
scope: {read: true, write: false, account: true}
name: 'Scrumble'
DO NOT COMMIT THIS FILE
sudo adduser dockeradmin && sudo groupadd docker && sudo gpasswd -a dockeradmin docker
sudo cp -R ~/.ssh /home/dockeradmin && sudo chown -R dockeradmin:dockeradmin /home/dockeradmin/.ssh
There are many commands in the makefile that are self comprehensible. Please, read the makefile.
In order to connect to the app on your machine, you'll need to have a Trello key:
- Go to the Trello developer key generator
- Get your public key (top of the page) and:
- copy it in
docker-compose.dev.yml
- copy it in
client/src/app.coffee
in theTrelloClientProvider.init
parameters - copy it in
client/src/login/config/trello.coffee
- copy it in
- Get your secret key (bottom of the page) and copy it in
docker-compose.dev.yml
Create the docker-machine remote host make create-host remoteip=xxx.xxx.xxx.xxx
.
Build&push all docker images from local and pull them from remote: make build-deploy-all
.
The email will probably arrive in the spam folder.
apt install mutt
DB_USER=xxx
DB_NAME=xxx
DB_CONTAINER=xxx
TO=xxx
echo "FILENAME=dump_\`date +%d-%m-%Y"_"%H_%M_%S\`.sql
docker exec $DB_CONTAINER pg_dump --username=$DB_USER $DB_NAME > \$FILENAME
echo \"You'll find attached the Scrumble backup\" | mutt -a \$FILENAME -s \"Scrumble Backup\" -- $TO
rm \$FILENAME" >> backup.sh
chmod +x backup.sh
echo "0 0 * * * ~/backup.sh" >> /var/spool/cron/crontabs/root
If the HTTPS certificates expire, follow these steps:
- Deploy the application again
- See the docker-letsencrypt-nginx-proxy-companion doc.
- Check the status (it should be renewed)
- if not force renewal
docker rmi $(docker images -f "dangling=true" -q)