https://github.com/mohitjaisal/syncode
A platform where users can code along with all their teammates and change it live on the platform with the help of their room id without even logging in or signing up.
https://github.com/mohitjaisal/syncode
code codechat codeeditor editor hacktoberfest idm mern reactjs synccode terminal vxcode
Last synced: 3 months ago
JSON representation
A platform where users can code along with all their teammates and change it live on the platform with the help of their room id without even logging in or signing up.
- Host: GitHub
- URL: https://github.com/mohitjaisal/syncode
- Owner: mohitjaisal
- Created: 2022-07-19T18:12:14.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-11T17:39:00.000Z (over 3 years ago)
- Last Synced: 2023-05-16T17:32:42.611Z (over 2 years ago)
- Topics: code, codechat, codeeditor, editor, hacktoberfest, idm, mern, reactjs, synccode, terminal, vxcode
- Language: JavaScript
- Homepage: https://syncode.mohitjaisal.com
- Size: 304 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# 𝐒𝐲𝐧𝐂𝐨𝐝𝐞 🚀
## ⭐ Introduction
SynCode is a platform where users can code along with all their team-mates and change it live on the platform with the help of their room id without even logging in or signing up.
## 🔥 Getting Started With The Project
- Fork the Project.
Click the gray `Fork` button in the top right of this page. This creates _your_ copy of the project and saves it as a new repository in your github account.
- Clone the Forked Repository in your Local System.
Click on the green `Code` button, then either the HTTPS or SSH option and, click the icon to copy the URL.
- Run the following commands in your code editor's terminal:
```bash
git clone https://github.com/mohitjaisal/Syncode.git
```
Switch to the cloned folder.
```bash
cd Syncode
```
Make a new branch.
```bash
git checkout -b
```
- Download, Install & Configure `NodeJS` in your system.
Make sure that `NPM` is also installed.
See the section about [NodeJS](https://nodejs.org/en/#download) for more information.
- Install Dependencies
```bash
npm install
```
- To run the project in Development mode, go to the `scripts` inside `package.json` & set the "start" script as:
```bash
"start": "npm run build && npm run server:dev"
```
This runs the app in the development mode.
- To run the project in Production mode, go to the `scripts` inside `package.json` & set the "start" script as:
```bash
"start": "npm run build && npm run server:prod"
```
This runs the app in the production mode.
- Run this command in your code editor's terminal to Fire Up the Local Server.
```bash
npm start
```
Now open http://localhost:5000 in your browser to view the Live Website.
## 🚀 Deployment
```bash
npm run build
```
Builds the app for the production mode inside the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
## 🔨 Tools Used
- Library:
- codemirror
- express
- react
- react-avatar
- react-dom
- react-hot-toast
- react-router-dom
- react-scripts
- socket.io
- socket.io-client
- uuid
- web-vitals
- nodemon
- Framework: ExpressJS
- Version Control System: Git
- Version Control System Hosting: GitHub
- Programming / Scripting: JavaScript
- Front-End: HTML, CSS, ReactJS
- Runtime Environment: NodeJS
- Integrated Development Environment: VSCode
- Hosting: Heroku
## 🔗 Links
### **_Checkout the Live Website:_** [SynCode](https://syncodeapp.herokuapp.com)
## 💻 Screens
## :heart: Open Source Contribution
> Contributions make the Open Source Community such an amazing place to learn, inspire, and create.
>
> All your contributions are truly appreciated.
### If you want to contribute to this project, then follow the [Contribution Guidelines](https://github.com/mohitjaisal/Syncode/blob/master/CONTRIBUTING.md) **_carefully_**.
#### I hope you like the project. Thanks for reading! 😀