/coderplex-backend-nodejs

Coderplex backend repository written in NodeJs

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

coderplex-backend

Coderplex.org API server

About

This project uses Feathers. An open source web framework for building modern real-time applications.

Getting Started

Getting up and running is as easy.

  1. Make sure you have NodeJS and npm installed.

  2. Install your dependencies at the root of the repository

    $ yarn

  3. Rename .env.sample to .env

    $ mv .env.sample .env

  4. Get GitHub And LinkedIn OAUTH client_id and client_secret

    • Follow this guide for github and this guide for linkedin
    • Use these as Authorization callback URL while registering
      • For Github http://localhost:4000/auth/github/callback
      • For LinkedIn http://localhost:4000/auth/linkedin/callback
    • And finally assign client_id and client_secret of each in .env file

  5. Install Mongodb Community Edition. And follow instruction to an instance of mongodb in another terminal.

  6. Start your app with

    $ yarn start

Testing

Simply run yarn test and all your tests in the test/ directory will be run.

Scaffolding

Feathers has a powerful command line interface. Here are a few things it can do:

# Install Feathers CLI
$ npm install -g feathers-cli

# Generate a new Service
$ feathers generate service

# Generate a new Hook
$ feathers generate hook

# Generate a new Model
$ feathers generate model

# Show all commands
$ feathers help

For more information on all the things you can do with Feathers visit docs.feathersjs.com.