There is no centralized platform to check the status of services at NTU. Inspired by downdetector, the goal is to create a platform for real time user reports of student issues such as internet connection, printer up-time etc. This allows users to have easy access to whether a problem has occurred while also giving the relevant administrators the ability to quickly rectify a problem.
- React
- MySQL
- NextJS
- NodeJS
This is a Next.js project bootstrapped with create-next-app.
Create a .env.local file to store your MySQL database configs securely which will be ignored by git. Follow the template shown in .env.example
Make sure to create a local MySQL database in your local machine before running the development server. Run the SQL setup file in setup.sql. This will create the standard database with dummy data.
Run the development server:
npm run dev
# or
yarn devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.
The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.
- Create a new branch from the main repository. Name it according to the feature or bug you are fixing eg. cards_feature.
- Make your commits in this new branch
- Submit a pull request when the code is ready to be merged. Assign someone to review your changes.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.