5-thirty

e6 staff stats aggregator

Development Setup

The following instructions are for setting up a local development environment.

Prerequisites

1. Install Node.js
   The project uses Node 20 and above
2. Install Yarn
   We use yarn instead of npm
3. Install PostgreSQL
   This is the database we use
4. Install pgAdmin 4 (optional)
   For easy database management

Getting Started

1. Clone the repository

git clone https://github.com/clynamic/5-thirty.git

2. Set up the Frontend
   Follow the instructions in the README

3. Install dependencies

yarn

4. Set up your database
   Create a PostgreSQL database for the project

5. Set up your environment
   Copy .env.example to .env and fill in the required values

6. Start the development server
   It will be available at http://localhost:3000

yarn dev

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

• NestJS - js backend framework
• Typescript - javascript with types
• Yarn - package manager
• ESLint - linting
• Prettier - code formatting
• Jest - testing framework
• TypeORM - database ORM
• PostgreSQL - database
• Orval - API client generator
• Axios - HTTP client
• date-fns - date time library