NUS FinTech Website Frontend

This repository contains the code for the frontend of the official NUS FinTech Website.

It is a Next.js project bootstrapped with create-next-app.

Installation

1. Clone the repository and install the dependencies of the project.

npm install

2. Create a .env.local file and insert the backend url which can be obtained from the backend repository or the vercel project dashboard.

// production database
NEXT_PUBLIC_BACKEND_URL=data-eye-289210.df.r.appspot.com/

// local database => use this for development mode
NEXT_PUBLIC_BACKEND_URL=http://127.0.0.1:8000/

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

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

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

Learn More

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

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

Deployed on Vercel

The project is deployed on the Vercel Platform from the creators of Next.js.

The domain is mapped to the nus computing domain at https://www.fintechsociety.comp.nus.edu.sg/.

Hosting

For help to request for a change in hosting ip for existing hostnames managed by SOC, contact Sing Ing at limsi@nus.edu.sg.

Documentation

Refer to this link for NUS Fintech technical documentation.

Once PR is merged to master, changes made to docs folder will be reflected in the github page website.

just-the-docs is used for template's documentation. You should also install the necessary Jekyll tools in order to contribute in this section.

To run Jekyll locally:

1. Run bundle exec jekyll serve --config _config_local.yml on your terminal.
2. Open localhost:4000 on your browser.