StylePoint

Multi-functional internal tool for StyleTech

Setup

Prerequisites

Docker:
- Windows/Mac: Install Docker Desktop (this is available free, ignore the "Choose Plan" button, and scroll down to the download button).
- Linux: Install Docker Engine.
Node.js: Install Node.js version 22. You can download it from the official Node.js website or use a version manager like volta
pnpm: Install pnpm globally using npm (which comes with Node.js):
```
npm install -g pnpm
```

Installation

Clone the repository and install the project dependencies using pnpm:

git clone <repository-url>
cd <repository-directory>
pnpm install

Setting up Environment Variables & Compose File

Copy the example .env.example file to .env and update the values (primarily passwords or access tokens) as required.

Copy the example docker-compose.example.yml file to docker-compose.yml and update the password as required (matching that set in the .env file).

Running the Development Server

To start the development server, run:

docker compose up -d
pnpm run dev

This will start the PostgreSQL server on localhost:5432 and the application server accessible at http://localhost:9100.

I recommend using Postico for Mac or pgAdmin for Windows to manage the PostgreSQL database.

Building for Production

To create a production build of the application, run:

pnpm run build

This command compiles and optimizes the application for deployment. The output files are usually placed in the dist directory.

1.8 KiB Raw Blame History