UoA Discords / Website

Main organization and server registry website.

This is our main website, which interfaces our UoA Discord server registry (see our server registry API) and contains information about our organization and other projects.

We are not affiliated with the University of Auckland in any official capacity.

The production version of this website is hosted at https://uoa-discords.com.

Table of Contents

• Technologies
• Installation
• Documentation
  • Script Reference
  • Dependency Reference
  • Configuring the App
• Contributing
• Licensing

Technologies

Installation

Dependencies:

• Node JS v16 or higher. Non-LTS and versions below 16 will probably work, but haven't been tested.
• pnpm, recommended but npm and yarn should still work fine.

You can easily get pnpm using:

npm i -g pnpm

Next you can set up the repository from a terminal:

git clone https://github.com/UoA-Discords/website.git website
cd website
pnpm install

All done! You can now run scripts using pnpm <script name>, e.g. pnpm start. See the script reference below to get started.

Documentation

Script Reference

• start Starts a development version of the website with hot-reloading enabled.
• build Creates a production-ready version of the website to statically host.
• lint Makes sure code follows style rules.
• typecheck Makes sure there are no type errors in the code.
• check-all Does linting and typechecking, note that this requires pnpm.

Dependency Reference

• axios Helps with making web requests to our API.

Configuring the App

If you want to edit some properties of the website, such as the API URL it makes requests to (e.g. if you're running a local version of our server registry API), you can do so by going to the /settings page.

Contributing

Contributions are always welcome, check out CONTRIBUTING.md to get started.

Licensing

This API is licensed under the MIT license.