EAR Development Challenge

A simple login system built with Node.js, Express, Pug, MongoDB, and Tailwind CSS. This project includes user registration, login, and user dashboard page with session management using express-session.

Features

User registration and login
User account page
Session management
Styled using Tailwind CSS
Docker support for easy setup

Prerequisites

Node.js >= 18
Docker (optional for backend, mandatory for the mongodb server*)

* Otherwise you'll need to provide a mongodb server URI manually

Installation

Clone the repository:

git clone https://github.com/thundree/ear-challenge.git
cd ear-challenge

Install dependencies:

yarn install

Set up environment variables:

Create .env.development or .env.production files based on the provided sample:

# .env.development
NODE_ENV=development
MONGO_INITDB_ROOT_USERNAME=system_admin
MONGO_INITDB_ROOT_PASSWORD=9MFY3dKBfQc6d
MONGO_DATABASE=dev

# .env.production
NODE_ENV=production
MONGO_INITDB_ROOT_USERNAME=system_admin
MONGO_INITDB_ROOT_PASSWORD=9MFY3dKBfQc6d
MONGO_DATABASE=prod

Build the Tailwind CSS if you updated the project layout/pages:

yarn build:css

Running the Application

Using Node.js

Start the development server:

yarn dev

Start the production server:

yarn build
yarn start

Using Docker

Start both containers in production:

yarn docker:up

Stop both containers:

yarn docker:down

Build and start the backend container:

yarn backend:start

Start the database container:

yarn database:start

Testing / Validating

Access

http://localhost:3000/

Project Structure

ear-challenge/
│
├── backend/
│ └── Dockerfile
├── database/
│ └── docker-compose.yml
├── src/
│ ├── config/
│ │ └── index.ts
│ ├── models/
│ │ └── User.ts
│ ├── scripts/
│ │ └── addUser.ts
│ ├── views/
│ │ ├── account.pug
│ │ ├── home.pug
│ │ ├── layout.pug
│ │ ├── login.pug
│ │ └── register.pug
│ ├── public/
│ │ ├── tailwind.css
│ │ └── tailwind-built.css
│ └── index.ts
├── .env.development
├── .env.production
├── package.json
├── tailwind.config.js
└── postcss.config.js