to be determined
From within the root directory:
npm installThis will handle both client and server-side dependencies as outlined in package.json.
after installation has completed
npm startthen navigate to localhost:3001/
to be determnied
See CONTRIBUTING.md for contribution guidelines. Make sure you have Node installed, and then from within the root directory:
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.
npm test
npm test:watchTODO// Additionally, this repo contains a dummy-data file that will help you test feel and look. To add records to the database just run:
./dummy-data.shThere is one types of objects stored in the database so far: students. 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
}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.
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