Awesome
Academy Students
Developed specially for Kyiv Spiritual Academy of Krishna Consciousness in Ukraine and ISKCON.
Run development environment
- Run
docker compose up
- Wait for images are downloaded, containers are created and launched, all software is installed inside the containers and all services are started
- Type
http://localhost:3000
in your browser (default credentials areadmin@example.com/password
) - Ude VSCode to develop inside the container
- attach to
students_crm_v1-app-1
container - open
/home/app/students_crm
folder
- attach to
Restore production backup locally
- Run
docker volume rm students_crm_v1_postgres-data
- Run
docker compose up postgres -d
- Run
docker compose cp [PATH TO BACKUP] postgres:/backup
- Run
docker compose exec postgres pg_restore -d va_db -O -j 20 -c /backup/db -U postgres
- Run
docker compose down
- Run
rm -rf uploads
- Run
tar -xzf [PATH TO BACKUP]/uploads.tar.gz -C .
Contribution guide
You should have 2 remote repositories: origin (your fork) and upstream (main repository)
- Fork repository using GitHub
git clone git@github.com:you/project.git
git remote add upstream git@github.com:KyivKrishnaAcademy/ved_akadem_students.git
git checkout master
git pull upstream master
- Check issue tracker for assigned tickets
git checkout -b my_important_feature_or_bugfix
- Work on your feature
- Setup PhantomJS
source bin/setup_phantomjs.sh
- Run tests
npm run test
git add .
git commit -m '[issue_number_here] My commit detailed message'
git push origin my-important-feature
- Send Pull Request at GitHub
- Goto 4
Deploy
bin/build_image_prod.sh
docker compose exec app bash
eval "$(ssh-agent -s)"
ssh-keygen -t rsa -b 4096 -C "deployer@docker.local"
ssh-add ~/.ssh/id_rsa
ssh-copy-id deployer@students.veda-kiev.org.ua
bundle exec cap deploy
Links
- Deployed project http://students.veda-kiev.org.ua
- Issue tracker for contributors https://github.com/KyivKrishnaAcademy/ved_akadem_students/issues
- Wiki https://github.com/KyivKrishnaAcademy/ved_akadem_students/wiki