Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aryaman1706/redoc

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/aryaman1706/redoc
Owner: Aryaman1706
Created: 2020-05-02T15:29:19.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-01-06T03:45:36.000Z (almost 2 years ago)
Last Synced: 2023-03-08T03:53:27.076Z (over 1 year ago)
Language: JavaScript
Size: 3.01 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 30
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # ReDoc | RealTime Collaborative Doc Editor

## How to Run the application on your machine?

1. Clone the repository :- `git clone https://github.com/Aryaman1706/ReDoc.git`

2. Navigate to the folder via command line.

3. Install [npm packages](https://www.npmjs.com/) for the backend :- `npm i`

4. Navigate to the client folder :- `cd client`

5. Install [npm packages](https://www.npmjs.com/) for the frontend :- `npm i`

6. Go back to the root folder :- `cd ..`

7. Start the Application :- `npm run dev`

## Quick Description of ReDoc

I tried to make a go-to application for all those people who want to collaborate in any form of documentation be it a report, marketing proposal or a readme file for an application. Basically anything where quality text in priortized over formating and designing.

## Technical Specification

> MERN Stack

**Frontend**

* React application bootstraped by [create-react-app](https://create-react-app.dev/).

* [Context API](https://reactjs.org/docs/context.html) - To manipulate state.

* CSS framework :- [Materialize CSS](https://materializecss.com/).

* [Socket.io -client](https://github.com/socketio/socket.io-client#readme) package used to provide RealTime functionality.

**Backend**

* [Node.js](https://nodejs.org/en/) - JavaScript runtime built.

* [Express.js](https://expressjs.com/) - Minimal [Node.js](https://nodejs.org/en/) web application framework.

* [MongoDB](https://www.mongodb.com/) - Database service.

* [Socket.io](https://socket.io/) - To provide RealTime functionality.

* [Express-fileupload](https://www.npmjs.com/package/express-fileupload) - To help with file upload.

* [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken) - To help with user authentication.

## Screen Shots of the Application

![Doc Preview](images/1.PNG)

***

![Doc Body](images/2.PNG)

***

## Demo Video

[![Demo Video](images/4.PNG)](https://www.youtube.com/watch?v=Zc9EatPEKVo)

## My vision for future updates to the application.

* Make the application more fluid.

* Improve the user experience.

* Implement chat functionality amongst the collaborators of the document.