Server and PostgreSQL database Hosted on Railway, runs on Ruby 3.2.1, Rails 7, MailerSend for emails, Mailcatcher for development. Application performance monitoring sponsored by AppSignal.
| Name | Value/Description |
|---|---|
| PGUSER | Username of your local postgres user |
| PGPASSWORD | Password of respective user |
| APPTUS_EMAIL_HOST | apptus.online |
| Name | Value/Description |
|---|---|
| PGUSER | Username of your local postgres user |
| PGPASSWORD | Password of respective user |
| APPTUS_EMAIL_HOST | apptus.online |
| RAILS_ENV | test |
| Name | Value/Description |
|---|---|
| RAILS_ENV | production |
| RAILS_MASTER_KEY | Secret key |
| RAILS_SERVE_STATIC_FILES | 1 |
| APPTUS_HOST | apptus.online |
| APPTUS_EMAIL_HOST | apptus.online |
| REDIS_URL | ${{Redis.REDIS_URL}} (Railway thing) |
| DATABASE_URL | ${{Postgres.DATABASE_PRIVATE_URL}} (Railway thing) |
Firstly, fork this repo to your GitHub account.
# Clone to your local machine
# Replace `YOURUSERNAME` with your GitHub username
$ git clone 'https://github.com/YOURUSERNAME/Apptus.git'
$ cd Apptus
# Create new branch for your changes
$ git checkout dev
# Replace `my-new-feature` with something more descriptive
$ git checkout -b my-new-feature
# Install dependencies
$ bundle install
# Set dev environment variables now, before next commands
# Set up database
$ rails db:setup
# Run mailcatcher
$ gem install mailcatcher # If not already installed
$ mailcatcher
# Run the server
$ rails sMake sure all tests run with no errors or warnings before making a PR. Run these tests with the Test Environment Variables listed above.
SimpleCov is used to check code coverage, run $ COVERAGE=1 rails test to generate a report.
$ rails test
$ rails test:system
$ bundle exec bundler-audit --update
$ bundle exec brakeman -q -w2
$ bundle exec rubocop --parallelmain is production. All changes should go through dev branch first (via a PR).