General Guide

Main Pages

Front-End

• App.js - This file is only used to set up the Router Switch that is the backbone of the App
• index.js - As it dictates, this is the main file in a React App, however, we only use it to render the App

Back-End

• index.js - This is the file that runs EVERY backend component as of now

How to Run

In order to run the local code (ie: just the front-end) open whatever terminal you prefer, navigate to the project folder, and run yarn start, this will open the react-app at localhost:3000.

If you want to run any back-end code, including fetching from databases etc, you'll need to open another terminal, navigate to the folder and run yarn server. This will allow for instant updates for both front-end and back-end.

Basic Infrastructure Explained

The app is divided into the following sections/subsections:

• Main Website
• Member Website [UNDER CONSTRUCTION]
• EBoard Panel [UNDER CONSTRUCTION]
• UPE API [UNDER CONSTRUCTION]
• Recruitment Website [FUTURE UPDATE IMPORTING INQUISITOR]

Each of these sections has its own Wiki page that goes further into detail into each one, how it works, etc.. please refer to each of these sections before starting to work on any of them, read the documentation carefully and make sure to adhere by global standards.

Global Standards

• All styling must be in ./styles/{SECTION}/, make sure to read each styling guide before doing any CSS work
• All files must be in ./assets/{FILETYPE}/, make sure to read the guide for the specific implementation before naming the files, they tend to have conventions
• Spacing in css files follows a 4-space tab, while in js files it follows a 2-space tab, please use this spacing style so the code is consistent
• When building HTML components, please make use of react-strap and react-bootstrap components to make the code more consistent, especially the use of <Container>, <Row> and <Col> to make sure the content is appropriately displayed on every device

Routing

All page routes are defined under ./constants/routes. All main website routes are directly under the domain, meaning that they are accessible via upe.bu.edu/..., meanwhile all routes for the Member Website are under ../panel, while EBoard admin routes are under .../EBoard.