IT5090 Capstone Project: Telugu Badminton Club of Canterbury

Introduction

This repository contains the frontend website for the IT5090 Capstone Project (Q4 2022). The author is Hugh Lilly (ID 20220344).

Companion backend repository

This site displays the information contained in the CMS in the repository hughlilly/tbcc-db. Set up and install dependencies for that repository first before moving to this one.

Source code

Architecture

This site uses the SSR React framework Remix.

Running locally

Prerequisites

Node.js (>=14)
npm (>6)

Installation

Environment variables

First, create a file to hold your environment variables by duplicating the included sample file:

cp .env.example .env

Open .env and paste the Strapi API token created during the setup of the backend repository as the value for STRAPI_API_TOKEN (i.e., after the equals sign). Save the file.

Install dependencies and start server

Run this series of chained commands:

npm i && npm run dev

This should install all dependencies, and start the Remix server. Open the localhost link to view the site.

Deployed version

This site is deployed to Render at http://tbcc.onrender.com. I am using the free tier of Render so initial loads may cause the instance to spin up. If the site does not load initally, try again a few minutes later, or contact me.

Images

All images are sourced from Unsplash.

Contact

Contact the author, Hugh Lilly (ID 20220344), by email (20220344@mywhitecliffe.com) if you have any questions.