6oclock

e6 staff dashboard

Development Setup

Prerequisites

1. Install Node.js (20+)
2. Install Yarn
3. Install Docker and Docker Compose

Getting Started

1. Clone the repository

git clone https://github.com/clynamic/6oclock.git

2. Install dependencies

yarn

3. Set up your environment

Copy .env.example to .env and fill in the required values. Copy compose.override.example.yml to compose.override.yml.

4. Start the development servers

yarn dev

This brings up PostgreSQL and Redis in Docker, then runs the API and web dev servers on the host.

Deployment

For production, we recommend using our Docker setup.

1. Ensure you have Docker and Docker Compose installed.

2. Set up your environment

Copy .env.example to .env and fill in the required values. Database configuration can be removed, as the Docker setup includes a PostgreSQL container.

3. Start the services

docker compose up -d

Stack

API (packages/api)

• NestJS - backend framework
• TypeORM - database ORM
• PostgreSQL - database
• Jest - testing framework

Web (packages/web)

• Vite - frontend build tool
• React - frontend library
• Material-UI - component library
• React Query - data fetching
• React Hook Form - form handling
• React Router - routing
• React Grid Layout - dashboard layout

Shared

• TypeScript - javascript with types
• Yarn - package manager
• ESLint - linting
• Prettier - code formatting
• Orval - API client generator
• Axios - HTTP client
• date-fns - date utility library