unihackhq / unihack.net

UNIHACK Website

UNIHACK Site - unihack.net

This is the source code that powers the unihack.net website. This website is running on the Next.js framework, using both TypeScript and SASS.

Getting Started

Requirements

You will need:

• Node 10.x or above

Installing

You should be able to install all the dependencies by running the following command:

npm install

Running Locally

You can run this locally in development mode by running the following command:

npm run dev

To use the environment variables you will need the vercel CLI:

npm i -g vercel

You can pull the environment variables by running the following command and following the prompt:

vercel env pull

Development mode includes hot-code reloading, error reporting and other functionality from Next.js. You can read more here

To view the website, visit http://localhost:3000.

You can also run it locally in "production mode" - which allows you to see what the site looks like when deployed before you merge. You can do this by:

npm run build
npm start

You can read more about production mode here

Linting

We use tslint to ensure code consistency, readability, and maintainability. You can run this through:

npm run lint

Folder Structure

• components: Primitive React components used on our website
• content: Content and JSON blobs (e.g. judge biographies, event information)
• layouts: Core layouts
• pages: Next.js pages
• public: Next.js location to serve static files (e.g. images, robots.txt)
• sections: Page sections - takes in content and components
• styles: Global styles and SASS stylesheet variables

Image Component

This website uses next.js image component to render images. Please use instead of when declaring images. More information here: https://nextjs.org/docs/api-reference/next/image

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Anthony Roberts 💻 🎨 🔣	Terence Huynh 💻 🎨 🔣	Josh Parnham 💻	sameersyedhd 💻	Erfan 💻	GhinaY 💻	Daniel Sykes-Turner 💻
Hugo 💻	sph-huynh 💻	Nick Ang 💻	Austin (Thang Pham) 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Third Party Libraries

Our emojis come from Twitter's Twemoji library. \n Copyright 2020 Twitter, Inc and other contributors. \n Code licensed under the MIT License: http://opensource.org/licenses/MIT \n Graphics licensed under CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/