Skip to content

Commit 9ffc95a

Browse files
changes
0 parents  commit 9ffc95a

File tree

19 files changed

+20295
-0
lines changed

19 files changed

+20295
-0
lines changed

.github/workflows/main_code-xerox.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Docs for the Azure Web Apps Deploy action: https://github.com/Azure/webapps-deploy
2+
# More GitHub Actions for Azure: https://github.com/Azure/actions
3+
4+
name: Build and deploy Node.js app to Azure Web App - Code-Xerox
5+
6+
on:
7+
push:
8+
branches:
9+
- main
10+
workflow_dispatch:
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Set up Node.js version
20+
uses: actions/setup-node@v3
21+
with:
22+
node-version: '20.x'
23+
24+
- name: npm install, build, and test
25+
run: |
26+
npm install
27+
npm run build --if-present
28+
npm run test --if-present
29+
30+
- name: Zip artifact for deployment
31+
run: zip release.zip ./* -r
32+
33+
- name: Upload artifact for deployment job
34+
uses: actions/upload-artifact@v3
35+
with:
36+
name: node-app
37+
path: release.zip
38+
39+
deploy:
40+
runs-on: ubuntu-latest
41+
needs: build
42+
environment:
43+
name: 'Production'
44+
url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}
45+
46+
steps:
47+
- name: Download artifact from build job
48+
uses: actions/download-artifact@v3
49+
with:
50+
name: node-app
51+
52+
- name: Unzip artifact for deployment
53+
run: unzip release.zip
54+
55+
- name: 'Deploy to Azure Web App'
56+
id: deploy-to-webapp
57+
uses: azure/webapps-deploy@v2
58+
with:
59+
app-name: 'Code-Xerox'
60+
slot-name: 'Production'
61+
package: .
62+
publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_867E399F16054043984ADE529F381B9D }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules

README.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
<div id="top"></div>
2+
3+
<!-- PROJECT LOGO -->
4+
<br />
5+
<div align="center">
6+
<a href="https://github.com/RaviPandey2002/Code-Xerox">
7+
<img src="public/IMG/logo.png" alt="Logo" width="150" height="140">
8+
</a>
9+
10+
<h1 align="center">Code Xerox</h1>
11+
12+
<p align="left">
13+
A collaborative code editor with live code sharing and video calling. Try out with this given <a href="https://code-xerox-i8fr.onrender.com/7b8e8984-fa4f-47db-8dd7-a9736322a016?host=_">Project link</a>.
14+
</p>
15+
</div>
16+
17+
18+
19+
<!-- TABLE OF CONTENTS -->
20+
<details>
21+
<summary>Table of Contents</summary>
22+
<ol>
23+
<li>
24+
<a href="#about-the-project">About The Project</a>
25+
<ul>
26+
<li><a href="#Main-feature-of-the-code-xerox-are-as-follows">Features of this project</a></li>
27+
<li><a href="#built-with">Built With</a></li>
28+
</ul>
29+
</li>
30+
<li>
31+
<a href="#getting-started">Getting Started</a>
32+
<ul>
33+
<li><a href="#prerequisites">Prerequisites</a></li>
34+
<li><a href="#installation">Installation</a></li>
35+
</ul>
36+
</li>
37+
<li><a href="#usage">Usage</a></li>
38+
<li><a href="#contributing">Contributing</a></li>
39+
<li><a href="#contact">Contact</a></li>
40+
<li><a href="#Vote-of-Thanks">Vote of thanks</a></li>
41+
</ol>
42+
</details>
43+
44+
45+
46+
<!-- ABOUT THE PROJECT -->
47+
## About The Project
48+
49+
When a text editor is outfitted with collaborative editing capabilities, and real time conversation it can be a show stopper. There are a number of applications available that excel at offering such functionality.
50+
I wanted to design and build a system that could handle simple text editing along with communication and collaboration. Using the Code Xerox, several users may collaborate on documents in real time. The current editing stances of other users are always visible via Remote-Cursors.
51+
52+
53+
## Main feature of the code xerox are as follows
54+
* Multiple users can edit code in real time. :revolving_hearts:
55+
* You can communicate in real time via video andd audio call :phone:
56+
* Syntax highlighting is present currently supporting C-like languages. :smile:
57+
* You can create as many rooms as you want [but currently have a scalibility issues] :hugs:
58+
* You can also chat in chat window :speech_balloon:
59+
60+
<p align="right">(<a href="#top">back to top</a>)</p>
61+
62+
63+
64+
### Built With
65+
66+
Major frameworks/libraries used to bootstrap your project.
67+
68+
1) HTML
69+
2) CSS
70+
3) JavaScript
71+
4) NodeJs
72+
5) Expressjs
73+
6) Socket.io
74+
7) Peerjs
75+
8) Uuid
76+
9) Code mirror
77+
78+
<p align="right">(<a href="#top">back to top</a>)</p>
79+
80+
81+
82+
<!-- GETTING STARTED -->
83+
## Getting Started
84+
85+
Follow thses steps to run the code on your local host.
86+
To get a local copy up and running follow these simple example steps.
87+
88+
### Prerequisites
89+
90+
This is an example of how to list things you need to use the software and how to install them.
91+
* npm
92+
```sh
93+
npm install npm@latest -g
94+
```
95+
96+
### Installation
97+
98+
1. Clone the repo
99+
```sh
100+
gh repo clone https://github.com/RaviPandey2002/Code-Xerox.git
101+
```
102+
2. Install NPM packages
103+
```sh
104+
npm install
105+
```
106+
4. Open the terminal in the root folder and run the command
107+
```sh
108+
npm run dev
109+
```
110+
111+
#### Open in the http://localhost:3000 to open the instance of the app and copy the link in the other tab and see the magic.
112+
<p align="right">(<a href="#top">back to top</a>)</p>
113+
114+
115+
116+
<!-- USAGE EXAMPLES -->
117+
## Usage
118+
119+
120+
<img src="public/IMG/main.png" alt="Logo" width="1000" height="576">
121+
122+
<img src="public/IMG/home.png" alt="Logo" width="1000" height="576">
123+
124+
### You can also use the given hosted link to talk with your friend [ If it does not work try multiple time because it has scalibility and ping issues. I promise it will work :crossed_fingers: ]
125+
126+
<p align="right">(<a href="#top">back to top</a>)</p>
127+
128+
129+
130+
131+
<!-- CONTRIBUTING -->
132+
## Contributing
133+
Any contributions you make are **greatly appreciated**.
134+
135+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
136+
Don't forget to give the project a star! Thanks again!
137+
138+
1. Fork the Project
139+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
140+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
141+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
142+
5. Open a Pull Request
143+
144+
<p align="right">(<a href="#top">back to top</a>)</p>

cicd

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Deploy to Azure App Service
2+
3+
on:
4+
push:
5+
branches:
6+
- app-service-deployment
7+
8+
jobs:
9+
build-and-deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout Source
13+
uses: actions/checkout@v3
14+
- name: Setup Node.js version
15+
uses: actions/setup-node@v4
16+
with:
17+
node-version: '20.x'
18+
- name: Install Dependencies
19+
run: npm install
20+
- name: Deploy to Azure App Service
21+
uses: azure/webapps-deploy@v2
22+
with:
23+
app-name: Code-Xerox
24+
publish-profile: ${{ secrets.AZURESECRET }}
25+
package: .
26+
27+

0 commit comments

Comments
 (0)