Skip to content

Latest commit

 

History

History
42 lines (23 loc) · 1.12 KB

DEVELOPMENT.md

File metadata and controls

42 lines (23 loc) · 1.12 KB

Development

Setup

First things first, you'll need to fork and clone the repository to your local machine.

git clone https://github.com/ecosyste-ms/digest.git

The project uses ruby on rails which have a number of system dependencies you'll need to install.

Once you've got all of those installed, from the root directory of the project run the following commands:

npm install
npm start

You can then load up http://localhost:8080 to access the service.

Docker

Alternatively you can use the existing docker configuration files to run the app in a container.

Run this command from the root directory of the project to start the service.

docker-compose up --build

You can then load up http://localhost:8080 to access the service.

Tests

The applications tests can be found in test and use the built in testing framework https://nodejs.org/api/test.html.

You can run all the tests with:

npm test

Deployment

A container-based deployment is highly recommended, we use dokku.com.