Technical Documentation for Developer¶
Client-Side Application¶
React and NextJS (the specific React variant that is being used) is used for creating the client-side application for both the "frontend-subsection" and "backend-subsection" of the website. The purpose of this application is to make an interactive and intuitive web application design.
The design is carried over from Material UI with templates from Creative Tim Material Dashboard (for the sponsor-facing website) + Material Kit (for the front-facing website).
Server-Side Application¶
ExpressJS/FeathersJS is used to create the server-side application that the client-side application connects to. The purpose of this application is to facilitate permission and data transformation and retrieval from the database. The database will be using a MongoDB, a NoSQL database that is excellent for OLTP operation and fast-protyping.
Simple Changes¶
React is mostly just a better HTML. If you require very simple changes in the website such as just a tagline or information, just go to the client
folder and perform a find
. Find the place you want to replace, and change it as you see fit.
Branch out from the main
branch. Commit the change that you made. Go to Github Pull Request, and create a pull request. Get the change reviewed and merge. Then go to the deployment server, and do a git pull
, and follow the deployment procedure.