README.md
# <img src="misc/nusmods-logo.svg" alt="NUSMods" width="224" />
Welcome to [NUSMods](https://nusmods.com), the open-source college course catalogue, module search, and timetable builder for the National University of Singapore!
We are a passionate team of students and alumni dedicated to enhancing school life through technology. With NUSMods, we assist over 30,000 students every semester in planning their timetables and finding the best modules to take.
## Usage
For users, you can access our website at [nusmods.com](https://nusmods.com). There's no mobile app, but our website is mobile-friendly and can be pinned to your home screen on Android and iOS.
If you need to access NUSMods data programmatically, we provide a [public API](https://api.nusmods.com/v2/) for you to retrieve the necessary information. Additionally, if you wish to export your timetables, we offer [timetable export service](https://export.nusmods.com/) that you can use. Please be considerate and use these services responsibly.
## Contributing
We welcome contributors of all skill levels and backgrounds. Our [contribute page](https://nusmods.com/contribute) goes over the various ways you can contribute to NUSMods for general users.
For developers and designers, our [contributing guide](/CONTRIBUTING.md) will help first-time contributors get started. For more advanced topics, we have an [architecture overview](/ARCHITECTURE.md) that explains how the various projects in this repository fit together.
To run the website locally, refer to this [guide](/website/README.md).
Quite a few of our contributors are students who started contributing to NUSMods with no prior experience. They have since gone on to internships and full-time jobs as software engineers / designers / founders. We are happy to help you get started and learn new skills!
## Community and Support
### Connect with us
You can reach us through the following channels, listed in order of preference:
- Telegram: https://t.me/nusmods
- Messenger: https://m.me/nusmods
- Email: mods@nusmods.com
- Facebook: https://www.facebook.com/nusmods
- Twitter: https://twitter.com/nusmods
### Acknowledgements
We would like to express our gratitude to all the contributors who have made this project possible. Check out the [list of contributors](https://github.com/nusmodifications/nusmods/graphs/contributors) who have dedicated their time and effort.
### Backers and Sponsors
We extend our heartfelt thanks to our backers and sponsors. You can [become a backer](https://opencollective.com/nusmods#backer) or [sponsor this project](https://opencollective.com/nusmods#sponsor) and have your logo/profile picture featured with a link to your website.
<a href="https://opencollective.com/nusmods#backers" target="_blank"><img src="https://opencollective.com/nusmods/backers.svg?width=890"></a>
<a href="https://opencollective.com/nusmods/sponsor/0/website" target="_blank"><img src="https://opencollective.com/nusmods/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/nusmods/sponsor/1/website" target="_blank"><img src="https://opencollective.com/nusmods/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/nusmods/sponsor/2/website" target="_blank"><img src="https://opencollective.com/nusmods/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/nusmods/sponsor/3/website" target="_blank"><img src="https://opencollective.com/nusmods/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/nusmods/sponsor/4/website" target="_blank"><img src="https://opencollective.com/nusmods/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/nusmods/sponsor/5/website" target="_blank"><img src="https://opencollective.com/nusmods/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/nusmods/sponsor/6/website" target="_blank"><img src="https://opencollective.com/nusmods/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/nusmods/sponsor/7/website" target="_blank"><img src="https://opencollective.com/nusmods/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/nusmods/sponsor/8/website" target="_blank"><img src="https://opencollective.com/nusmods/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/nusmods/sponsor/9/website" target="_blank"><img src="https://opencollective.com/nusmods/sponsor/9/avatar.svg"></a>
## License
All projects and packages in this repository are [MIT licensed](LICENSE).
## Supported by
[BrowserStack][browserstack] lets us ensure NUSMods functions across all browsers and devices by allowing us to test NUSMods on real devices, including Safari on older iPhones and previous versions of browsers.
[<img src="misc/browserstack-logo.png" width="236" />][browserstack]
[1Password] lets us manage our account passwords, identities and keys as a team securely and efficiently.
[<img src="misc/1password-logo.png" width="200" />](1password)
[Netlify](netlify) automatically deploys our branches so we can easily test incoming Pull Requests.
[<img src="misc/netlify-logo.png" width="190" />](netlify)
[browserstack]: https://www.browserstack.com/
[1password]: https://1password.com/
[netlify]: https://www.netlify.com