-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Ritik Srivastava
authored
Jul 2, 2020
1 parent
6b78d8d
commit c5b0d94
Showing
1 changed file
with
135 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| # Multi-Dimensional-Text-Editor | ||
| This is a multi dimensional in which many number of editor can work together on one platform with an live chatting system provided | ||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
| <p align="center"> | ||
| <a href="https://github.com/alexanderritik/Multi-Dimensional-Text-Editor/blob/master/Screenshot%202020-07-02%20at%2011.18.59%20PM.png"> | ||
| <img src="https://github.com/alexanderritik/Multi-Dimensional-Text-Editor/blob/master/Screenshot%202020-07-02%20at%2011.18.59%20PM.png" alt="Logo" width="1200" height="800"> | ||
| </a> | ||
|
|
||
| <h3 align="center">Live - Editor </h3> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://live-texteditor.herokuapp.com/">View Demo</a> | ||
| </p> | ||
|
|
||
|
|
||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| ## Table of Contents | ||
|
|
||
| * [About the Project](#about-the-project) | ||
| * [Built With](#built-with) | ||
| * [Getting Started](#getting-started) | ||
| * [Prerequisites](#prerequisites) | ||
| * [Installation](#installation) | ||
| * [Usage](#usage) | ||
| * [Roadmap](#roadmap) | ||
| * [Contributing](#contributing) | ||
| * [License](#license) | ||
| * [Contact](#contact) | ||
|
|
||
|
|
||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
| ## About The Project | ||
|
|
||
| [Live editor](https://live-texteditor.herokuapp.com/) | ||
|
|
||
| This is a live editing platform where multiple user can editing on same platform . Just create a unqiue room join by your name and start editing and chatting both as real time. | ||
| Here's why: | ||
| * To provide similar platform as leetcode live playground | ||
| * We can do real time chat for clearing doubts | ||
| * We can do pair editing | ||
|
|
||
| Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. | ||
|
|
||
| A list of commonly used resources that I find helpful are listed in the acknowledgements. | ||
|
|
||
| ### Built With | ||
| This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. | ||
| * [Bootstrap] | ||
| * [JAVASCRIPT] | ||
| * [NODEJS] | ||
| * [EXPRESS] | ||
| * [SOCKET] | ||
| * [MUSTACHE] | ||
|
|
||
|
|
||
|
|
||
| <!-- GETTING STARTED --> | ||
| ## Getting Started | ||
|
|
||
| This is an example of how you may give instructions on setting up your project locally. | ||
| To get a local copy up and running follow these simple example steps. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| This is an example of how to list things you need to use the software and how to install them. | ||
| * npm | ||
| ```sh | ||
| npm install npm@latest -g | ||
| ``` | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Get a Preview at [https://live-texteditor.herokuapp.com/](Live - editor) | ||
| 2. Clone the repo | ||
| ```sh | ||
| git clone https://github.com/alexanderritik/Multi-Dimensional-Text-Editor.git | ||
| ``` | ||
| 3. Install NPM packages | ||
| ```sh | ||
| npm install | ||
| ``` | ||
|
|
||
| <!-- USAGE EXAMPLES --> | ||
| ## IDEA | ||
|
|
||
| So one day me and my friend were doing a pair programming on leetcode live playground and I was really fascinated by this feature. How more than 2 member can join and programming in one place and clear each other doubts. | ||
| So I thought making it as one of my project. So I started project with Socket.js nodejs and expressjs . | ||
|
|
||
| Here we can see a live editor and real time chat sytem .which can be used to go online and do live editing. | ||
|
|
||
|
|
||
|
|
||
| <!-- ROADMAP --> | ||
| ## Roadmap | ||
|
|
||
| See the [open issues](https://github.com/alexanderritik/Multi-Dimensional-Text-Editor/issues) for a list of proposed features (and known issues). | ||
|
|
||
|
|
||
|
|
||
| <!-- CONTRIBUTING --> | ||
| ## Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
|
|
||
|
|
||
|
|
||
| <!-- LICENSE --> | ||
| ## License | ||
|
|
||
| Distributed under the MIT License. See `LICENSE` for more information. | ||
|
|
||
|
|
||
|
|
||
| <!-- CONTACT --> | ||
| ## Contact | ||
|
|
||
| Your Name - [@ritik_srivastava](https://www.instagram.com/ritik_srivastava/) - Alexander Ritik | ||
|
|
||
| Project Link: [https://live-texteditor.herokuapp.com/](live-text Editor) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|