ihsClubSite

A club site made with Next.js and ❤️

Usage

Getting started

To get the repository setup, follow these steps

$ git clone https://github.com/InterlakeProgrammingClub/ihsClubSite.git
$ cd ihsClubSite
$ npm i

Configuration

Club Info

If you would like to change the club info, head over to src/json/clubs.json and setup the below info.

Parameter	Optional?	Accepts
name	no	string
description	yes	string
route	no	string representing a route
contact	yes	string
clubcontact	yes	string
room	yes	string
advisor	yes	string
day	yes	string
image	yes	path to image

Note that if you would not like to include info, you may leave it as an empty string ("")

Example:

[
	{
		"name": "Programming Club",
		"description": "We love programming!",
		"route": "/programming",
		"contact": "",
		"clubcontact": "admin@interlakeprogrammingclub.com",
		"room": "727",
		"advisor": "Bezos",
		"day": "Monday",
		"image": "/logos/programming.png"
	}
]

Contact Form

By default, the form in /contact is not shown. If you would like it to show/change the link, you can follow these steps.

1. Copy .env.example into .env
2. Set the link of your form

Club Times

If you want to change when the clubs start and end, you can change the following string environment variables:

• NEXT_PUBLIC_WEDNESDAY_START_END_TIME
• NEXT_PUBLIC_START_END_TIME

Others

If you would like to change anything else, you can directly edit the code and use it, as long as it follows our license

Final Steps

Finally, you can go ahead and start the webserver.

For development:

$ npm run dev

For production:

$ npm run build
$ npm start

Contributing

If you would like to help contribute to this project, you can either create an issue or make a pull request.

Authors

• @FireStreaker2
• @TNTiger17
• @brachiotusk
• @HongyiRen2009

License

MIT