PAYSTACK WARS

Paystack Star Wars

• Installation
• Starting App
• Docker

Installation

These instructions are for use without docker

• Clone the repository https://github.com/hackthievist/star-wars-movies.git
• Make sure that Node.js is installed.
• Install Node.js modules with yarn YarnPKG:

yarn install

Documentation

• The API documentation with Postman can be found here

Starting App

• To run the app, copy the file .env.example to .env and substitute the settings to match your development environment.
• Make sure postgres is installed and running if you plan on using the app locally.
• Start the app with yarn:

yarn start

• Navigate to localhost:1400. Please note 1400 is the default port used, you can change this in .env. ` d

Testing

• Tests are written using the Mocha library.
• To run tests with yarn use:

yarn test

Docker

Using Docker Standalone - Compose (Recomended for local development)

• Copy the file docker-config/secrets.env.example to docker-config/secrets.env and substitute the settings to match your development environment.

Make sure postgres is installed locally by running psql

docker-compose up -d

• see logs

docker-compose logs -f

• tear down

docker-compose down

Visit App

• Navigate to https://paystack-wars.herokuapp.com or http://localhost:1400(docker standalone)

Stack

• Backend Language + Framework: Nodejs + Sails.js
• Database: PostgreSQL
• Hosting Server: Heroku
• Testing Framework: Mocha
• Container Platform: Docker
• Cache: Redis