Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Naresh-chandanbatve authored Jun 13, 2024
1 parent 49218d8 commit eca1c74
Showing 1 changed file with 91 additions and 5 deletions.
96 changes: 91 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,94 @@
# React + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
<!-- Env Variables -->
### :key: Environment Variables

Currently, two official plugins are available:
To run this project, you will need to add the following environment variables to your .env file

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
#### Client Environment variables

`VITE_BACK_URL=http://localhost:5000`

`VITE_FRONT_URL=http://localhost:5173`

#### Server Environmnet variables

`MONGO_URL=your mongodb url`

`USER_SECRET=user secret`

`SESSION_SECRET=session secret`

`SMTP_HOST=smtp host`

`SMTP_PORT=smtp port`

`SMTP_SERVICES=smtp serice`

`SMTP_MAIL=smtp mail`

`SMTP_PASSWORD=smtp password`

`CLIENT_ID=google client id`

`CLIENT_SECRET=google client secret`

`BASE_URL=http://localhost:5000`

`FRONT_URL=http://localhost:5173`

`APP_ID=cashfree app id`

`SECRET_KEY=cashfree secret key`


<!-- Run Locally -->
### :running: Run Locally

Clone the project

```bash
git clone https://github.com/Naresh-chandanbatve/decor.git
```

Go to the project directory

```bash
cd decor
```

#### For Backend Server

Go to the Bckend directory

```bash
cd backend
```

Install dependencies

```bash
npm install
```

Start the server

```bash
npm run server
```

#### For Client
In another termianl, First go to root directory

Install dependencies

```bash
npm install
```

Start the server

```bash
npm run dev
```

go to to any browser and paste `http://localhost:3000`

0 comments on commit eca1c74

Please sign in to comment.