Skip to content

Commit 5fa0287

Browse files
Kartik BehlKartik Behl
authored andcommitted
Add readme file and fix dependency
1 parent 844a83a commit 5fa0287

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Sendight
2+
3+
Sendight is a Peer-to-Peer file sharing platform built on the top of webRTC.
4+
5+
## How to setup sendight-backend
6+
7+
- Clone the repository using `git clone https://github.com/thephilomaths/sendight-backend`
8+
- Install all the dependencies using `yarn install`
9+
- Migrate and seed the database using the following commands:
10+
```
11+
cd project_root/src/db
12+
npx sequelize-cli db:migrate
13+
npx sequelize-cli db:seed:all
14+
```
15+
- Serve the backend using `yarn start`
16+
17+
## Tech Stack
18+
19+
- Node.js
20+
- Sequelize
21+
- Socket.io

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@
2525
"eslint-plugin-prettier": "^3.4.0",
2626
"husky": "4",
2727
"prettier": "^2.2.1",
28-
"sequelize-cli": "^6.2.0",
2928
"typescript": "^4.2.4"
3029
},
3130
"dependencies": {
3231
"cors": "^2.8.5",
3332
"express": "^4.17.1",
3433
"sequelize": "^6.6.2",
3534
"socket.io": "^4.0.1",
36-
"sqlite3": "^5.0.2"
35+
"sqlite3": "^5.0.2",
36+
"sequelize-cli": "^6.2.0"
3737
}
3838
}

0 commit comments

Comments
 (0)