Skip to content

alphatrl/classmaid

Repository files navigation

smu-shortcut logo

Classmaid

Your digital campus guide for schools in Singapore.
This site is non-affiliated with any Singapore-based schools.


smu-shortcut promotion-image


💻 Try it

Visit Classmaid.sg

🤩 Features

  • Bookmarks of commonly-used websites used by schools
  • View upcoming school events
  • View current school term event

🛠 Develop

Run the following commands:

# Clone the repo
git clone https://github.com/alphatrl/classmaid.git && cd classmaid

# Install dependencies
yarn install

# Copy the env.example files
cp .env.example .env

# Run the app (Development)
yarn dev

# Run the app (Production)
yarn build
yarn start

Open http://localhost:3000 to view it in the browser.

💾 Data

The data used by SMU-Shortcuts is stored in smu-scraper

🙋 Contribute

If you found a bug, or if you have an idea for this app, please file an issue here. We appreciate your feedbacks and inputs.

📜 License

MIT License. See LICENSE file for more information.

⭐️ Credits

Created by Amos

A huge thanks to the following contributors for their amazing work:

Duncan Leo Chester How