diff --git a/README.md b/README.md index 4adfc1f..0fc6db1 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,53 @@ Multi-functional internal tool for StyleTech -## Install the dependencies +## Setup + +### Prerequisites + +1. **Docker**: + * **Windows/Mac**: Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) (this is available free, ignore the "Choose Plan" button, and scroll down to the download button). + * **Linux**: Install [Docker Engine](https://docs.docker.com/engine/install/). +2. **Node.js**: Install Node.js version 22. You can download it from the [official Node.js website](https://nodejs.org/) or use a version manager like [volta](https://docs.volta.sh/guide/getting-started) +3. **pnpm**: Install `pnpm` globally using npm (which comes with Node.js): + ```bash + npm install -g pnpm + ``` + +### Installation + +Clone the repository and install the project dependencies using `pnpm`: + ```bash -yarn -# or -npm install +git clone +cd +pnpm install ``` -### Start the app in development mode (hot-code reloading, error reporting, etc.) +### 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: + ```bash -quasar dev +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](http://localhost:9100). + +I recommend using [Postico](https://eggerapps.io/postico/) for Mac or [pgAdmin](https://www.pgadmin.org/) for Windows to manage the PostgreSQL database. + +### Building for Production + +To create a production build of the application, run: -### Build the app for production ```bash -quasar build +pnpm run build ``` -### Customize the configuration -See [Configuring quasar.config.js](https://v2.quasar.dev/quasar-cli-vite/quasar-config-js). +This command compiles and optimizes the application for deployment. The output files are usually placed in the `dist` directory. \ No newline at end of file