Skip to content
This repository has been archived by the owner on Jan 5, 2020. It is now read-only.

Pierre-RA/skilful-buddies-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SkilfulBuddies API

Codeship Coveralls Gemnasium label license

Webpack + Typescript + Express + Jest + Chai

How to use SkilfulBuddies API

Install

$ yarn

A post install script will transpile Typescript code into javascript. Transpiled code can be found at ./dist/server.js.

Environment variables

Name Default Description
PORT 3000 PORT on which the server will run
SIGNUP_STATUS off signup status: off | restricted | on
ADMIN_TOKEN null ADMIN_TOKEN for signup process
MONGODB_URI null mandatory mongodb URI
SECRET_SERVER_KEY simple-server-key key for jwt

Tests

$ yarn test

Send coverage to coveralls

$ COVERALLS_REPO_TOKEN=XXXX yarn test-ci

You need to add your coveralls repository token, otherwise it will fail.

Run

$ yarn start

This will launch the server as is.

$ yarn pm2

This will launch the server with pm2 instead.

Description

A small Express application written in Typescript and set with Webpack. Tests are done with Jest + Mocha/Chai.

You can find the demo app running at: https://api-skel.herokuapp.com/.

Authors

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published