https://github.com/dbm-dynamic-border-management/dbm-api

This is a Rails 6 api for the mattermost dbm plugin.
https://github.com/dbm-dynamic-border-management/dbm-api

api docker management mattermost postgres rails rails6 redis

Last synced: 8 days ago
JSON representation

This is a Rails 6 api for the mattermost dbm plugin.

• Host: GitHub
• URL: https://github.com/dbm-dynamic-border-management/dbm-api
• Owner: DBM-Dynamic-Border-Management
• License: apache-2.0
• Created: 2021-06-24T16:23:51.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-06-25T09:45:49.000Z (over 3 years ago)
• Last Synced: 2024-11-02T16:25:38.523Z (13 days ago)
• Topics: api, docker, management, mattermost, postgres, rails, rails6, redis
• Language: Ruby
• Homepage:
• Size: 46.9 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DBM-API

This is a Rails 6 app.

## Documentation

This README describes the purpose of this repository and how to set up a development environment. Other sources of documentation are as follows:

* UI and API designs are in `doc/`

## Prerequisites

This project requires:

* Ruby 3.0.0, preferably managed using [rbenv][]

* Chromedriver for Capybara testing

* PostgreSQL must be installed and accepting connections

* [Redis][] must be installed and running on localhost with the default port

On a Mac, you can obtain all of the above packages using [Homebrew][].

If you need help setting up a Ruby development environment, check out this [Rails OS X Setup Guide](https://mattbrictson.com/rails-osx-setup-guide).

## Getting started

### with docker

* On your rails folder :

docker build -f base.Dockerfile -t dbm .

cp .env.example .env

* On the project's root folder :

docker-compose up

### bin/setup

Run the `bin/setup` script. This script will:

* Check you have the required Ruby version

* Install gems using Bundler

* Create local copies of `.env` and `database.yml`

* Create, migrate, and seed the database

### Run it!

1. Run `bin/rake test` to make sure everything works.

2. Run `bin/rake test:system` to run system (capybara) tests.

3. Run `bin/rails s` and `bin/sidekiq` to start the app and Sidekiq; alternatively, start both at once with `heroku local`.

## Deployment

Ensure the following environment variables are set in the deployment environment:

* `POSTMARK_API_KEY`

* `RACK_ENV`

* `RAILS_ENV`

* `REDIS_URL`

* `SECRET_KEY_BASE`

* `SIDEKIQ_WEB_PASSWORD`

* `SIDEKIQ_WEB_USERNAME`

Optionally:

* `HOSTNAME`

* `RAILS_FORCE_SSL`

* `RAILS_LOG_TO_STDOUT`

* `RAILS_MAX_THREADS`

* `RAILS_SERVE_STATIC_FILES`

* `WEB_CONCURRENCY`

[rbenv]:https://github.com/sstephenson/rbenv

[redis]:http://redis.io

[Homebrew]:http://brew.sh

## Contribute

If you have any issues or idea to contribute to the app, create an issue and explain everything inside