The following guide explain how to install jQuest for development purpose.
This may change according to your OS. On Ubuntu you must install those header packages to be able to compile ruby dependencies:
sudo apt-get install ruby-dev libpq-dev libsqlite3-dev
Assuming you already installed Ruby, Bundler and Bower on your computer.
make install
You must specify a few environment variables. Those variables can be set using
a file config/local-env.yml (it will be loaded when the app will start).
| Name | Description | Examples |
|---|---|---|
| DB_ADAPTER | The database adapter to use | postgresql, sqlite3 |
| DATABASE_URL | The database URI to use | postgres://user:password@localhost:5432/jquest, db/development.sqlite3 |
| SLACK_API_TOKEN | User API token to connect to Slack you can get from here. | xoxp-XXXXXXXXXXX-XXXXXXXXXXX-XXXXXXXXXXX-XXXXXXXXXXX |
For instance, to use the app with SQLite:
DB_ADAPTER: sqlite3
DATABASE_URL: db/development.sqlite
SLACK_API_TOKEN: xoxp-whatever-you-got-from-slackrails db:setup
If you use PostgreSQL, an alternative way to setup the database is to get a copy from the production. This is a destructive action since it remove your local database to fill it with real-life data. Use the following command:
make pg-pull
The app autoreloads when changing ruby files, or assets.
make run
To ease the deployment of jQuest, we provide a Dockerfile to build the app and get ready for production with a single command line:
docker build --build-arg ASSET_HOST=//assets.jquestapp.com -t jquest .
Note: Here we build the assets using the default host but it must be your own server or a CDN.
Use environments variables within your Docker host to configure the app. Any existing config/local-env.yml file will be ignored.
Assuming you named your container jquest as above, simply run:
docker run -p 3333:3000 -it jquest bin/web
Your app is now listening on localhost:3333
As mentioned above, jQuest can be configured with environment variables:
| Name | Description | Examples |
|---|---|---|
| DB_ADAPTER | The database adapter to use. | postgresql, sqlite3 |
| DATABASE_URL | The database URI to use. | postgres://user:password@localhost:5432/jquest, db/development.sqlite3 |
| SLACK_API_TOKEN | User API token to connect to Slack you can get from here. | xoxp-XXXXXXXXXXX-XXXXXXXXXXX-XXXXXXXXXXX-XXXXXXXXXXX |
| ASSET_HOST | Hostname that distribute the assets. | //asset.jquestapp.com |
| HOSTNAME | Hostname of the app (needed by mailers). | http://www.jquestapp.com |
| S3_BUCKET | Bucket name to upload files to. | static.jquestapp.com |
| AWS_ACCESS_KEY_ID | AWS access key id. | |
| AWS_SECRET_ACCESS_KEY | AWS secret key. | |
| AWS_REGION | AWS region to distribute files. | eu-west-1 |
| RAILS_SERVE_STATIC_FILES | Should Rails serve assets? | 1 |
| RAILS_LOG_TO_STDOUT | Should Rails print logs to stdout? | 1 |
| MEMCACHIER_SERVERS | If present, activates cache with Memcahier. List Memcahier servers. | something.ec2.memcachier.com:11211 |
| MEMCACHIER_USERNAME | Memcachier username. | |
| MEMCACHIER_PASSWORD | Memcachier password. | |
| NEW_RELIC_APP_NAME | If present, activates RPM measure with New Relic. | jquest |
| NEW_RELIC_LICENSE_KEY | New Relic Licence key. | |
| NEW_RELIC_LOG | New Relic source. | stdout |
| SENDGRID_USERNAME | If present, uses SendGrid as mailer. | contact@jplusplus.org |
| SENDGRID_PASSWORD | SendGrid passowrd. | |
| WEB_CONCURRENCY | Number of concurrent process to start with Puma | 1 |
Follow this tutorial to get SSL certificat from EFF. Enable SSL with Fatly using this tutorial.