Teachers need a system where they can perform administrative functions for their students. Teachers and students are identified by their email addresses.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

• Node.js
• MySQL

A step by step series of examples that will help you get a development environment running

1. Clone the repository:

git clone https://github.com/koozy0/govtech-assignment.git

2. Install dependencies:

cd ${path-to-project}
npm install

3. Create .env file.

touch .env

4. Update the .env file with the database configurations, using .env.example as the template.

5. Create the database schema for local development (develop) and testing (test).

6. Migrate the table definitions:

npm run db:migrate

7. Seed the database:

npm run db:seed

8. Start the server:

npm run dev

9. Check that the development server is running by sending a GET request to 127.0.0.1:3000 where 3000 is the default port. You can change the default port by creating a PORT environment variable in the .env. You should see the following response:

{
  "message": "Server works!"
}

Run the following command in the project directory to run the tests:

npm run test

To be added.

• Node.js
• Express
• MySQL
• Knex.js

• Koo Zheng Yu