From 03b66b854eedfdb787b768e5c1eccaa4e7bd215c Mon Sep 17 00:00:00 2001 From: Asad Date: Fri, 17 Jan 2025 15:36:28 -0500 Subject: [PATCH] chore: doc update --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a878bc3..caf1f9d 100644 --- a/README.md +++ b/README.md @@ -52,19 +52,36 @@ JWT_SECRET=your-secure-secret-here JWT_EXPIRES_IN=7d ``` -### 3. Adding users +### 3. Adding user ```bash node addUser.js "user@email.com" "password" ``` -### 4. Dev +### 4. Development server +Before starting the development server, ensure you change the Vue.js library import from `_prod` to `_dev` in [`index.html`](https://git.sheetjs.com/asadbek064/BinCode/src/commit/3e35da0118e8e6b44863b3fee12c1e2dff96b02e/public/index.html#L129). ```bash pnpm dev ``` ### 5. Production +Copy .env.example to .env and generate unique secret and cahnge NODE_ENV=production +1. Copy .env.example to .env: +```bash +cp .env.example .env +``` + +2. Generate a unique secret and set NODE_ENV=production in the .env file. + +3. Start the production server ``` pnpm start -```` \ No newline at end of file +```` + + +### 5. Production +- For development, using the `_dev` version of Vue.js (vue.global.js) is recommended as it includes debugging tools and warnings. + +- For production, switch to the `_prod` version (vue.global.prod.js) to optimize performance. +