Skip to content

Commit 9c8a3fa

Browse files
committed
created dev setup guide
1 parent b6b706e commit 9c8a3fa

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

Diff for: README.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# InstaShare
2+
3+
A simple application to upload large files and share them instantly.
4+
5+
# Dev setup guide
6+
7+
- Download and install MongoDB on your system: https://docs.mongodb.com/manual/installation/
8+
- Start the Mongo deamon
9+
- Clone and cd into the repo
10+
11+
SERVER SETUP:
12+
13+
- Go into the server folder
14+
- Create a .env file at the root specifying:
15+
```
16+
JWT_SECRET=<SET_RANDOM_SECRET_KEY/> - use 'openssl rand -base64 32' to create a secret key
17+
DB_CONNECTION=<SET_DB_CONNECTION/> - on localhost mostly: mongodb://localhost:27017/
18+
DB_NAME=<SET_DB_NAME/> - the name of a new or already existing db
19+
BUCKET_NAME=<SET_BUCKET_NAME/> - the name of the bucket where your files will be stored
20+
PORT=<SET_SERVER_PORT/> - the port on which your express server will be started. Default is 5000
21+
```
22+
- install node_modules with yarn install
23+
```sh
24+
$ yarn install
25+
```
26+
- install nodemon globally: https://www.npmjs.com/package/nodemon
27+
- start the server
28+
```sh
29+
$ yarn run dev
30+
```
31+
32+
CLIENT SETUP:
33+
- Go into the client folder
34+
- Create a .env file at the root specifying:
35+
```
36+
REACT_APP_SERVER_HOST=<SERVER_HOST /> - default should be: http://localhost:5000/
37+
```
38+
- install node_modules with yarn install
39+
```sh
40+
$ yarn install
41+
```
42+
- start the react development server
43+
```sh
44+
$ yarn run start
45+
```
46+
You can now sign up and upload your first files!

0 commit comments

Comments
 (0)