PTC Portal

Table of Contents

1. Usage
2. Development
3. Test Data
4. DB Schema
5. Server API

Development

Installing Dependencies

From within the root directory:

npm install

This will handle both client and server-side dependencies as outlined in package.json.

Make sure that you have created secrets.js file that contains secret for JWT and address for the mongoDB instance. Example below:

export default {
  mongo: 'mongodb://localhost/myLocalDatabaseInstance',
  jwt: 'mysecret'
};

after installation has completed

npm start

then navigate to localhost:3001/

Usage

to be determnied

Make sure you have Node installed, and then from within the root directory:

Node 5 or above has to be installed

Internal APIs

On any project there are many internal APIs. For ease of reference, for both the development team and future contributers, they are exhaustively documented here.

Test

To run test:

npm test

To run test continiously:

npm test:watch

DB Schema

There are two types of objects stored in the database so far: students and users. To minimize http requests on the server, when retrieved, all references to other objects will be fully populated with complete objects, not just is numbers. The schema are as follows:

####User

{
name       : ... //String
email      : ... //String
lesson     : ... //String
level      : ... //String
interview  : ... //String
decision   : ... //String
}

Server API

The server uses a stateless RESTful API for all database access. It supports four HTTP verbs: GET for retrieving data, POST for creating new objects, PUT for updating existing objects, and DELETE for removing objects. NOTE: All POST, PUT, and DELETE routes require an authorization token, with the exception of POST /api/signup.

The Routes

Most routes follow a /api/:data_type/:data_identifier pattern. Note that when an aspect of a route is prefaced with a colon : it refers to a variable. Do not actually write down a colon in any api calls. Additionally, ALL of the following routes must be prefaced with /api.

GET     api/students                // Get list of students
POST    api/student                 // Add new student
DELETE  api/student/:id             // Delete the student

GET     api/users                 // Get list of user
POST    api/users                 // Add new user
DELETE  api/users/:id             // Delete the user