School Management API Server

A simple Node.js server for managing students and teachers, built with Node.js, Express.js, Sequelize.js, overnight.js and MySQL.

Prerequisite

• Please ensure Node.js is installed in your machine.
• (Optional) If you are familiar with Zeit's Now serverless and would like to run serverless locally, please install now-cli.

Installation

• If you'd like run the project in your machine, please follow the steps below.
• Strongly suggest using yarn for better experiences.

1. Install dependencies

yarn

2. Run the project

Using ts-node - Monolithic

yarn start

(Optional) Using Zeit Now - Serverless

yarn dev

2. Browse the API

The api should be ready to use at localhost:3000/

Disclaimer

This project is solely for sharing and exchanging technological ideas and does not subject to any commercial use.

License

MIT