Skip to content

Commit 3b2feb3

Browse files
committed
docs: added install locally section
1 parent 5dc06dd commit 3b2feb3

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,51 @@ curl -XGET
5454
| :-- | :-- | :-- | :-- | :-- |
5555
| `ObjectId(id)` | `array` | `string` | `string` | `string`
5656

57+
58+
## Install Locally
59+
60+
Clone the project
61+
62+
```bash
63+
git clone https://github.com/Pathokun/Pathokun.git
64+
```
65+
66+
Go to the project directory
67+
68+
```bash
69+
cd Pathokun
70+
```
71+
72+
Install dependencies
73+
74+
```bash
75+
npm install
76+
```
77+
78+
Start the server
79+
80+
```bash
81+
npm run dev
82+
```
83+
> Don't forget to add `.env` file
84+
85+
## Environment Variables
86+
87+
To run this project, you will need to add the following environment variables to your .env file
88+
89+
`DB_STRING`
90+
91+
`JWT_SECRET`
92+
93+
`JWT_EXPIRES`
94+
95+
`JWT_PRIVATE_SECRET`
96+
97+
`JWT_RESET_SECRET`
98+
99+
`JWT_RESET_EXPIRE`
100+
101+
57102
## Contributing
58103
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
59104

0 commit comments

Comments
 (0)