API for ASD devotionals

Description

An API for retrieve ASD devotionals.
The database connection string is read from the MONGODB_URI environment variable, not hardcoded in the source. See Configuration.
Feel free to use it.

Installation

# Clone the repository
$ git clone https://github.com/jonathangomz/devotionals-api.git

# Install the dependencies
$ cd devotionals-api
$ npm install

Configuration

The app needs a MongoDB connection string. It is read from the MONGODB_URI environment variable and is not stored in the repository.

# Create your local env file from the template
$ cp .env.example .env

# Then edit .env and set MONGODB_URI to your own connection string

MONGODB_URI is required: the app throws on startup if it is missing rather than attempting to connect to an undefined URI. .env is gitignored, so never commit it or paste a real credential into the source.

Note: the original Heroku deployment for this project is retired. The Procfile is left over from it and is no longer used.

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Documentation

Read the Documentation for more information of how to use the api.

Stay in touch

• Author - Jonathan Gomez
• Twitter - @jonathangomz