Git Product home page Git Product logo

skilful-buddies-api's Introduction

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

skilful-buddies-api's People

Contributors

pierre-ra avatar

Watchers

James Cloos avatar  avatar

skilful-buddies-api's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.