https://github.com/alphalawless/googledocs-clone
📝 Just me playing a little bit of creating Google Docs clone. And I took advantage of it I went after creating something similar to Google Docs and I came across something called Quilljs.
https://github.com/alphalawless/googledocs-clone
docker googledocs-clone mongodb mongoose react
Last synced: 2 months ago
JSON representation
📝 Just me playing a little bit of creating Google Docs clone. And I took advantage of it I went after creating something similar to Google Docs and I came across something called Quilljs.
- Host: GitHub
- URL: https://github.com/alphalawless/googledocs-clone
- Owner: AlphaLawless
- License: mit
- Created: 2022-04-27T16:22:41.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-29T03:08:21.000Z (about 3 years ago)
- Last Synced: 2025-01-17T22:44:46.922Z (4 months ago)
- Topics: docker, googledocs-clone, mongodb, mongoose, react
- Language: TypeScript
- Homepage:
- Size: 97.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Google Docs Clone
A clone of the google docs from deep web. Just kidding 😆!
I was just wanting to do a google clone to learn more about the Quilljs API.
## Techs
### Front-end
- [React](https://reactjs.org) - Library I use to make the frontend.
- [Vite](https://vitejs.dev) - build tool that aims to provide a faster and leaner development experience for modern web projects.
- [Sass](https://sass-lang.com) - Responsible for front-end styling (even if little is useful).
- [Socketio](https://socket.io) - Communication between back-end - front-end.
- [Quilljs](https://quilljs.com/docs/quickstart/) - Quill is a modern WYSIWYG editor built for compatibility and extensibility.
### Back-end
- [Babel](https://babeljs.io) - Compiler the code.
- [Socketio](https://socket.io) - Communication between back-end - front-end.
- [Mongoose](https://mongoosejs.com) - Connection with mongodb.
- [Docker](https://www.docker.com) - Create a container with mongodb.
## Running project
### Prerequisites
Install yarn inside your machine:
```
npm install --global yarn
```
To execute the project follow the steps:
1. Clone this repository:
```
git clone https://github.com/AlphaLawless/googledocs-clone
cd googledocs-clone
```
2. Install dependencies:
```
yarn install
```
3. Move envorinment variable:
```
yarn environment
```
4. Running a container with a mongodb:
```
yarn mongodb:up
```
5. Run the backend and frontend on separate terminals:
```
cd client
yarn dev:client
cd server
yarn dev:server
```
## License
[MIT LICENSE](./LICENSE)