TMUCSA Website Project

Overview

This is the website for TMUCSA, a social club that promotes student wellbeing through various activities at TMU.

Information

Next.js has server sided rendering, backend, and frontend capabilities. Next.js is built on React.js, so you can utilize React packages. It allows an easier way of routing without react-router-dom. Simply put, it's easier learning Next.js than React.

Next.js routes work in the src/app/ directory. Basically if you want to go to a different part of the website, like tmucsa-website/about, create a directory called about and create a page.js file that renders in the HTML. It's that simple. For more information on how it works, check out the documentation

Command Line Tools Needed

• Git
• NodeJS

1. Clone the repo.

git clone https://github.com/TMUCSA/tmucsa-website.git

2. Change into the repo directory.

cd tmucsa-website

3. Switch to the branch that you are working on by using:

git checkout <branch-name>

Running the website

1. Install node modules

npm install

OR

npm i

2. Run the dev build of the project to view how it looks locally on your browser

npm run dev

3. The website will start running on

localhost:3000

Admin workspace

Approved TMUCSA administrators can manage events, team data, homepage media, and website copy from /admin.

See docs/ADMIN_GUIDE.md for local setup, Firebase rules, testing, and Vercel deployment instructions.

Coding

• Code in your respective or assigned branches to avoid git conflicts.
• Ensure to pull regularly to stay up to date with the dev branch.

Packages Used

TBD

---

Developers

| @andrearcaina | @chen-dominic | @Tristanv0 |