e6 staff dashboard

1. Install Node.js (20+)
2. Install Yarn
3. Install PostgreSQL

1. Clone the repository

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

2. Install dependencies

yarn

3. Set up your database

Create a PostgreSQL database for the project.

4. Set up your environment

Copy .env.example to .env and fill in the required values.

5. Start the development servers

yarn api
yarn web

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

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

• 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

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