almapp/uc-courses repository overview

⁠UC Courses REST API

⁠Development

⁠Prerequisites

• Node 5.3.x or newer
• MongoDB installed and running

⁠Preparation

Clone this repository:

git clone https://github.com/almapp/uc-courses.git
cd uc-courses

Install dependencies:

npm install

Run:

npm run develop

This will start the application and will be accessible on http://localhost:3000/⁠.

⁠Test

Run test suite with:

npm test

⁠Production

⁠Prerequisites

• Docker⁠
• Docker Compose⁠

⁠Setup

Clone this repository:

git clone https://github.com/almapp/uc-courses.git
cd uc-courses

Set the environment variables:

# Optional:
# Perform a GET to this endpoint to manually start the scraping
export SECRET_ENDPOINT=secret_route

Start with:

docker-compose up -d

See the logs with:

docker-compose logs