ecwk / bed-assignment-2

A submission for my school's backend web development (BED) assignment.

BED Assignment 2

This is a submission for my school's backend web development (BED) assignment.

The app is hosted on https://bed-assignment-2.deploy.cnoside.dev

What's inside?

Tech Stack

Frontend

• Next.js, a react-based framework
• Chakra UI, a component library

Backend

• Express.js, a backend web framework
• MySQL, a SQL database

Folder Structure

• apps/api: API powered by express
• apps/web: web app powered by next.js
• packages/eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier used by apps/web)
• packages/scripts: scripts used throughout the monorepo (includes custom-commit for formatting git commits)

Utilities

• Turborepo for building monorepos
• TypeScript for static type checking
• Jest for running tests
• Supertest for testing APIs
• ESLint for code linting
• Prettier for code formatting

How to Setup?

Prerequisites

• npm: ^8.0.0
• node: ^16.0.0
• MySQL Server

Setup The Environment

Refer to .env.example in both apps/api and apps/web.

Create .env in apps/api and .env.local in apps/web.

Run SQL Scripts

Linux (Bash)

cd bed-assignment-2/bin

chmod 700 db.sh

./db.sh

Windows (PowerShell)

cd bed-assignment-2\bin

./db.ps1

Start the App

For Development

To develop all apps and packages, run the following command:

# Ensure that NODE_ENV=development
cd bed-assignment-2

npm run dev

For Production

To start the app for production, run the following commands:

# Ensure that NODE_ENV=production
cd bed-assignment-2

npm run build

npm run start

Admin Credentials

By default the only admin is root

• Email: [e-mail]:
• Password: 1q!Q1q!Q

The root admin password should be changed after the first login.

Then, add more admins with the web interface