> **Branch notice:** This README belongs to the `Dev` branch and describes the **dev environment**. For live/production information, use the `main` branch. --- ## 🚀 Getting Started This project uses **Bun** as the package manager and runtime. Ensure you have Bun and PM2 installed globally before proceeding. ### Development To spin up the development server with Hot Module Replacement (HMR): ```bash bun run dev ``` > The dev server runs on `port 4001` and is accessible across your local network via `0.0.0.0`. ### Production Build To type-check the project and compile it for production: ```bash bun run build ``` --- ## 🏗️ Deployment & PM2 Management We use **PM2** to manage the production process, ensuring the application stays online and restarts automatically if it crashes. | Command | Description | | --- | --- | | `bun run start-prod` | Launches the production preview via PM2 under the name **tasgrid**. | | `bun run status` | View the status of the running PM2 processes. | | `bun run logs` | Tail the live logs for the **tasgrid** process. | | `bun run stop` | Stops the production process. | | `bun run deploy` | **Full Cycle:** Pulls latest code, builds, and restarts the process. | ### Quick Deploy If you have updated the code on your server, simply run: ```bash bun run deploy ``` --- ## 🛠️ Port Reference * **Development:** `4001` * **Production (Preview):** `4000` --- ## Usage ```bash $ npm install # or pnpm install or yarn install ``` ### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs) ## Available Scripts In the project directory, you can run: ### `npm run dev` Runs the app in the development mode.
Open [http://localhost:5173](http://localhost:5173) to view it in the browser. ### `npm run build` Builds the app for production to the `dist` folder.
It correctly bundles Solid in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.
Your app is ready to be deployed! ## Deployment Learn more about deploying your application with the [documentations](https://vite.dev/guide/static-deploy.html)