Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thatbackendguy/code-craft-pro
CodeCraftPro. - Collaborative Coding Enviroment
https://github.com/thatbackendguy/code-craft-pro
coding-en mern-stack nodejs reactjs socket socket-io
Last synced: 12 days ago
JSON representation
CodeCraftPro. - Collaborative Coding Enviroment
- Host: GitHub
- URL: https://github.com/thatbackendguy/code-craft-pro
- Owner: thatbackendguy
- Created: 2024-02-11T18:39:02.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-05T07:05:51.000Z (7 months ago)
- Last Synced: 2024-05-05T08:21:41.413Z (7 months ago)
- Topics: coding-en, mern-stack, nodejs, reactjs, socket, socket-io
- Language: JavaScript
- Homepage: https://code-craft-pro-five.vercel.app
- Size: 504 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Code Craft Pro.
## Introduction
CodeCraftPro is a collaborative coding platform powered by Node.js, React.js, and Socket.IO. It enables real-time code editing and project management for software development teams. With features like user authentication, workspace management, and file sharing, it streamlines the coding process, allowing teams to work together seamlessly. Boost productivity and streamline collaboration with CodeCraftPro.
## Tech-stack
* Node.js
* React.js
* Socket.IO
* Socket.IO-client
* Mongoose
* Express
* MongoDB
* Postman
> Recommended to use Node v20.0 or higher
Check your Node version by
```
node -v
```
For installing latest Node version for Ubuntu (snap)
```
sudo snap install node --classic
```
## Project Setup
1. Open terminal, run
```
git clone https://github.com/thatbackendguy/code-craft-pro
```
2. Goto backend folder to install backend dependencies.
```
cd backend
npm install
npm run dev
```
3. Goto frontend folder to install frontend dependencies.
```
cd frontend
npm install
npm start
```
4. Configure .env file in `backend` folder. By creating `.env` file
and copy and paste the below file into `.env` file and configure accordingly.
```
DB_URI=
SMTP_EMAIL=
SMTP_PASSWORD=
JWT_SECRET=
SMTP_HOST=
AES_SECRET=
```
5. Configure .env file in `frontend` folder. By creating `.env` file
and copy and paste the below file into `.env` file and configure accordingly.
```
REACT_APP_BACKEND_URL=
```
## Backend Routes
### User Routes
| Sr. No.|Description| Request Type | Endpoint |
|---|---|---|---|
|1|Sign Up| POST | `/api/user/signup` |
|2|Login| POST | `/api/user/login` |
|3|Logout| GET | `/api/user/logout` |
|4|OTP Verification|POST|`/api/user/otp-verification`|
5|Get User Metrics Data|GET|`/api/user/profile/:userID`|
### Editor Routes
| Sr. No.|Description| Request Type | Endpoint |
|---|---|---|---|
|1|Get Code Editor| GET | `/api/editor/:workspaceID/:folderID/:fileID` |
|2|Add Workspace| POST | `/api/workspace/add` |
|3|Get Workspace| GET | `/api/workspace/get/:userID` |
|4|Delete Workspace|DELETE|`/api/workspace/delete/:id`|
|5|Share Workspace|POST|`/api/workspace/share/:workspaceID`|
|6|Remove shared workspace|DELETE|`/api/workspace/share/:workspaceID`|
|7|Add Folder|POST|`/api/folder/add/:workspaceID`|
|8|Get all the folders of individual workspace|GET|`/api/folder/get-all/:workspaceID`|
|9|Delete Folder|DELETE|`/api/folder/delete/:folderID`|
|10|Share folder|POST|`/api/folder/share/:folderID`|
|11|Remove shared folder|DELETE|`/api/folder/share/:folderID`|
|12|Add File|POST|`/api/file/add/:folderID`|
|13|Get all the files of individual folder|GET|`/api/file/get-all/:folderID`|
|14|Delete File|DELETE|`/api/file/delete/:fileID`|
|15|Get File|POST|`/api/file/get/`|
|16|Save code in file|PUT|`/api/file/save-code/`|
|17|Add Collaborator to Workspace|POST|`/api/workspace/share/:workspaceID`|
|18|Remove Collaborator from Workspace|POST|`/api/workspace/share/delete/:workspaceID`|
|19|Get Collaborators by WorkspaceID|GET|`/api/workspace/share/:workspaceID`|
|20|Get Shared Workspace By UserID|GET|`/api/workspace/shared-with-me/:userID`|
|21|Get Comments|GET|`/api/file/comment-get/:fileID`|
|22|Add Comment|POST|`/api/file/comment-add`|
|23|Resolve Comment|DELETE|`/api/file/comment-resolve/:commentID`|
> Note: Correctly check the `PORT` where frontend and backend server is deployed
## GitHub Repo
