Product Analysis: NTU School of Computer Science and Engineering Club Website

Overview:

The NTU School of Computer Science and Engineering Club Website is a monorepo that contains the source code for the website of the SCSE Club at Nanyang Technological University. It also includes related applications and packages. The project utilizes turborepo to manage the monorepo structure.

Features:

• Appscms: The CMS & Admin Panel for the SCSE Club website.
• merch: Backend for the merchandise store for the SCSE Club.
• web: The SCSE Club website, built with Next.js.
• Packages:
  • eslint-custom-config: Custom ESLint config for SCSE Club projects.
  • nodelogger: A simple logger for Node.js.
  • schemas: Schemas for SCSE Club projects.
  • tsconfig: Custom TypeScript config for SCSE Club projects.
  • types: Types for SCSE Club projects.
  • ui: UI components for SCSE Club projects.

Installation:

To install the NTU School of Computer Science and Engineering Club Website, follow these steps:

1. Clone the repository:

   git clone [repository_url]
   

2. Install dependencies:

   cd [repository_folder]
   yarn install
   

3. Run development server:

   yarn dev
   

4. Build production bundles:

   yarn build
   

5. Lint the codebase with eslint:

   yarn lint
   

6. Format the codebase with prettier:

   yarn format
   

7. Run unit tests:

   yarn test
   

8. Run end-to-end tests with Cypress:

   yarn cypress
   

Summary:

The NTU School of Computer Science and Engineering Club Website is a comprehensive project that includes a CMS & Admin Panel, a merchandise store backend, and the main website built with Next.js. The project also provides various packages for custom ESLint configuration, logging, schemas, TypeScript configuration, and UI components. The installation guide provides step-by-step instructions for setting up and running the project for development and production environments. Overall, this project serves as a functional and versatile web solution for the SCSE Club at NTU.