Skip to content

mgtourney/website

Repository files navigation

Website 🖥️

The official website for Magnesium!

Consists of

Page Route Description
Frontpage / The frontpage of the website.
Team /team The team-page of the website.
Calendar (WIP) /calendar The calendar-page of the website.
Rules /rules The rules-page of the website.
Admin /admin The admin-page of the website. Requires authorization

JSON-paths:

File Hydrates
https://URL/assets/staff/data.json /calendar
https://URL/api/rules /rules
https://URL/api/rules /team

TODO:

Frontend

  • Restyle calendar/rules-page
  • Panel for controlling calendar/rules/team-page

Backend

  • Error handling on data-fetching
  • API routes for calendar/rules/team-page
    • Move calendar to database.
    • Move rules to database.
    • Move team-page to database.

Database 🗄️

Want to help?

Getting Started

First, install the dependencies:

npm install
# or
yarn

Then, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

Scripts

  • dev - Pretties the code & runs the development server.
  • build - Builds the application for production usage.
  • start - Runs the built application in production mode.
  • prod - Pretties the code, builds the application, and runs it in production mode.
  • lint - Runs ESLint on the project.
  • format - Runs Prettier on the project.

Learn More

To learn more about Next.js, take a look at the following resources:

To learn more about Tailwind CSS, take a look at the following resources:

To learn more about Flowbite, take a look at the following resources:

License 📜

This project is licensed under the GPLv3 License - see the LICENSE file for details