Skip to content

Commit d76924d

Browse files
committed
yarn -> npm
1 parent 86f4226 commit d76924d

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Are you tired of sending code snippets back and forth, struggling to debug and c
1717
### Prerequisites
1818

1919
- Node.js (v20.11.1)
20-
- npm (v10.2.4) or yarn
20+
- npm (10.2.4)
21+
- pm2 (5.3.1) : `npm i -g pm2`
2122

2223
I have used nvm (v0.39.7) to manage my node versions. View nvm official [documentation](https://github.com/nvm-sh/nvm) to install it.
2324

@@ -35,9 +36,9 @@ I have used nvm (v0.39.7) to manage my node versions. View nvm official [documen
3536
This project is not currently live on any server. But to use the demo version, follow the steps below:
3637

3738
- Clone this repository and cd into it
38-
- Run `yarn` to install the dependencies
39-
- To start the react app client run `yarn start` in one terminal
40-
- To start the server run `yarn server:dev` in another terminal
39+
- Run `npm install` to install the dependencies
40+
- To start the react app client run `npm start` in one terminal
41+
- To start the server run `npm server:dev` or `pm2 start server.js` in another terminal
4142
- Go to `http://localhost:3000` to view the app
4243
- Create a room by clicking on the `create new room` button and put a username of your choice
4344
- Copy the room id by clicking on the `Copy ROOM ID` button
@@ -46,6 +47,8 @@ This project is not currently live on any server. But to use the demo version, f
4647

4748
Now both your editor will be synced and you can see the changes in real time. Try opening the same room in multiple browsers/browsers-windows and see the changes.
4849

50+
**Note:** To stop your server (only if you used pm2) run `pm2 stop server.js` in the terminal
51+
4952
## Project Video
5053

5154
https://github.com/Mohitur669/Realtime-Collaborative-Code-Editor/assets/79283402/14c17cc7-d23a-4d39-8af3-ef9e9fa8ef45
@@ -99,4 +102,4 @@ I am Mohd Mohitur Rahaman, a tech geek, currently pursuing a Master's in Compute
99102
## Connect with me
100103

101104
- [LinkedIn](https://www.linkedin.com/in/mohitur02/)
102-
- [GitHub](https://www.github.com/Mohitur669/)
105+
- [GitHub](https://www.github.com/Mohitur669/)

0 commit comments

Comments
 (0)