https://github.com/tom-barone/jqc
Work management system built with Rails
https://github.com/tom-barone/jqc
bootstrap github-actions postgresql rails ruby
Last synced: 6 months ago
JSON representation
Work management system built with Rails
- Host: GitHub
- URL: https://github.com/tom-barone/jqc
- Owner: tom-barone
- License: mit
- Created: 2022-12-14T11:00:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-13T00:53:03.000Z (over 1 year ago)
- Last Synced: 2025-03-13T01:22:46.536Z (over 1 year ago)
- Topics: bootstrap, github-actions, postgresql, rails, ruby
- Language: Ruby
- Homepage:
- Size: 2.8 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JQC
[](https://github.com/tom-barone/JQC/blob/master/LICENSE)
[](https://github.com/tom-barone/JQC/actions/workflows/continuous-integration.yml) [](https://github.com/tom-barone/JQC/actions/workflows/continuous-deployment.yml) [](https://sonarcloud.io/summary/overall?id=tom-barone_JQC)
[](https://sonarcloud.io/summary/overall?id=tom-barone_JQC) [](https://sonarcloud.io/summary/overall?id=tom-barone_JQC) [](https://sonarcloud.io/summary/overall?id=tom-barone_JQC) [](https://sonarcloud.io/summary/overall?id=tom-barone_JQC)
Rails/PostgreSQL app deployed with Dokku and styled with Bootstrap.
## Getting started
All work is done on the `develop` branch.
After committing and pushing to `develop`, the [CI Github Action](https://github.com/tom-barone/JQC/actions/workflows/continuous-integration.yml) will:
1. Run the unit, integration and end to end tests.
1. Deploy a staging site.
1. Run a set of smaller, production safe checks against the staging site.
To deploy a new production version:
1. Do a manual smoke test of the staging site.
1. Create a pull request to merge `develop` -> `master`.
1. Once all checks have passed, the pull request will automatically merge.
1. The [CD Github Action](https://github.com/tom-barone/JQC/actions/workflows/continuous-deployment.yml) will deploy a new production version to dokku, run the production safe checks and create a new git release tag.
## Monitoring
If deployed using [tom-barone/web-server-init](https://github.com/tom-barone/web-server-init), there is a [Grafana](https://grafana.com) / [Graphite](https://graphiteapp.org/) instance available at `http://monitoring.` to use.
Definitions for a working Grafana dashboard and set of alerts are included in the `/monitoring` directory.
Alerts:
- Disk storage almost full.
- JQC RAM usage too high.
- System RAM usage too high.
- CPU usage too high.
## Deployment
### Dokku
```bash
# Create the app
ssh -t @ dokku apps:create
# Add the dokku git remote to the repo
git remote add ssh://dokku@:/
# Set the domain for the dokku container
dokku --remote domains:set
# Create & link postgres and redis containers (can limit memory usage in MB with --memory)
dokku --remote postgres:create -db --memory 1024
dokku --remote postgres:link -db
dokku --remote redis:create -redis
dokku --remote redis:link -redis
# Set important environment variables
dokku --remote config:set RAILS_MASTER_KEY=$(cat config/master.key)
dokku --remote config:set DOMAIN=
# Set on the staging environment
dokku --remote config:set STAGING=true
# Setup LetsEncrypt certs
# - Make sure to have your domain DNS settings point to the server before running this
dokku --remote letsencrypt:enable
# If using a branch other than main or master to deploy from
dokku --remote git:set deploy-branch
# Push the code to the server and deploy
git push
# Scale up the web and worker processes
dokku --remote ps:scale web=1 worker=1
# Limit the app resources, set these to whatever you need
# See https://docs.docker.com/engine/containers/resource_constraints
dokku --remote resource:limit --memory 1.5g --process-type web
dokku --remote resource:limit --memory 500m --process-type worker
dokku --remote resource:report
# Setup persistent logging to a file at /var/log/dokku/apps/.log
# The regular app logs are not kept between container restarts / deploys
dokku --remote logs:set vector-sink "file://?encoding[codec]=csv&encoding[csv][fields][]=timestamp&encoding[csv][fields][]=message&encoding[csv][quote_style]=always&path=/var/log/dokku/apps/.log"
dokku --remote logs:vector-start
# If using dokku-graphite and reporting with StatsD,
# this will make the environment variable STATSD_URL available in the app
dokku --remote graphite:link
# Anytime you need to deploy a new release
git push
```
You can omit the `` and keep it as the default `dokku` remote if you like. But it's nice if you've got a staging and production servers to have different remotes, e.g. `staging` and `production`. That way you can deploy to each server with:
```bash
git push staging master
git push production master
```
I like to use `pgAdmin` to interface with the postgres database, which can be done with SSH tunneling. First you'll need to expose the database port from the docker container to the host machine:
```bash
# Expose the database internally from dokku to 0.0.0.0 on the host
dokku --remote postgres:expose -db 5432
# Undo the port expose with
dokku --remote postgres:unexpose -db 5432
# View the connection string (password etc.) and use it in pgAdmin, along with relevant SSH tunnel settings
dokku --remote postgres:info -db
```
Sometimes it's handy to blast away the database and start fresh:
```bash
dokku --remote postgres:unlink -db
dokku --remote postgres:destroy -db --force
dokku --remote postgres:create -db
dokku --remote postgres:link -db
```
To recreate the database from a backup
```bash
# Downloads the most recent backup to ./backup/export
rake fetch_most_recent_backup
# For a local development database
pg_restore --clean --dbname= --exit-on-error backup/export
# For a dokku hosted database (you may need to blast away and recreate the database first)
dokku --remote postgres:import -db < backup/export
```
## Development
There are a few issues with `solid_queue` causing trouble when resetting the database. To reset everything from scratch so we can load in backed up data in development:
```bash
rails db:migrate:reset
rails db:drop:queue
# Reset the db/queue_schema.rb file
rails db:prepare
rake restore_development_db_from_most_recent_backup
```