https://github.com/coding-cactus/apptus
Cactus (green) themed group chat web app
https://github.com/coding-cactus/apptus
Last synced: about 2 months ago
JSON representation
Cactus (green) themed group chat web app
- Host: GitHub
- URL: https://github.com/coding-cactus/apptus
- Owner: Coding-Cactus
- License: gpl-2.0
- Created: 2023-03-27T19:43:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-17T16:18:35.000Z (about 1 year ago)
- Last Synced: 2025-03-24T17:01:45.681Z (2 months ago)
- Language: Ruby
- Homepage: https://apptus.online
- Size: 8.27 MB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Apptus
https://apptus.online
Server and PostgreSQL database Hosted on [Railway](https://railway.app/), runs on Ruby `3.2.1`, Rails 7, [MailerSend](https://app.mailersend.com/) for emails, [Mailcatcher](https://mailcatcher.me/) for development. Application performance monitoring sponsored by [AppSignal](https://www.appsignal.com/).
### Development Environment Variables
| Name | Value/Description |
|:-----------------------|:-------------------------------------|
| PGUSER | Username of your local postgres user |
| PGPASSWORD | Password of respective user |
| APPTUS_EMAIL_HOST | `apptus.online` |
### Test Environment Variables
| Name | Value/Description |
|:------------------|:-------------------------------------|
| PGUSER | Username of your local postgres user |
| PGPASSWORD | Password of respective user |
| APPTUS_EMAIL_HOST | `apptus.online` |
| RAILS_ENV | `test` |
### Production Environment Variables
| 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) |
### Contributing
#### Getting Started
Firstly, [fork this repo](https://github.com/Coding-Cactus/Apptus/fork) to your GitHub account.
```shell
# 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 s
```
### Running tests
Make sure all tests run with no errors or warnings before making a PR. Run these tests with the Test Environment Variables listed above.
[SimpleCov](https://github.com/simplecov-ruby/simplecov) is used to check code coverage, run `$ COVERAGE=1 rails test` to generate a report.
```shell
$ rails test
$ rails test:system
$ bundle exec bundler-audit --update
$ bundle exec brakeman -q -w2
$ bundle exec rubocop --parallel
```
### Deploying
[`main`](https://github.com/Coding-Cactus/Apptus/tree/main) is production. All changes should go through [`dev`](https://github.com/Coding-Cactus/Apptus/tree/dev) branch first (via a PR).