https://github.com/rez433/js_ramverk
Collaborative Text Editor
https://github.com/rez433/js_ramverk
bcrypt express jwt mongoose nextjs quilljs react-toastify socket-io
Last synced: 3 months ago
JSON representation
Collaborative Text Editor
- Host: GitHub
- URL: https://github.com/rez433/js_ramverk
- Owner: rez433
- Created: 2024-09-12T15:32:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T23:12:42.000Z (over 1 year ago)
- Last Synced: 2025-02-13T02:23:10.561Z (over 1 year ago)
- Topics: bcrypt, express, jwt, mongoose, nextjs, quilljs, react-toastify, socket-io
- Language: HTML
- Homepage: https://qlient.vercel.app
- Size: 844 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Collaborative text editor
## Features
Real time collaborative text editor built with:
server side:
- express
- mongodb
- mongoose
- socket.io
- jwt
- bcrypt
client side:
- nextjs
- quill
- socket.io-client
- react-toastify
- tailwindcss
Testing is done using vitest and jest-dom for frontend and jest and supertest for api.
## Setup and Installation
*Use your favoeite package manager npm, pnpm or yarn to install dependencies.*
Frontend is built with nextjs 14 with app router, wrapped inside `src` directory. It uses `webpack`but if you want to change it to `turbopack` you need to add **--turbo** to **dev script** in *package.json*
```
"scripts": {
"dev": "next dev --turbo",
"build": "next build",
"start": "next start",
"lint": "next lint",
"test": "vitest --coverage"
},
```
Add a `.env`file to the root of client and assign api url. If server is running locally, then api url is your localhost server (http://localhost:5051) or if it is hosted on a server assign the server address without any port number.
```
NEXT_PUBLIC_API_URL = "ur api address"
```
### Clone this repository:
```
git clone https://github.com/rez433/js_ramverk.git
cd server
pnpm i
pnpm dev
# and from the root of repo:
cd client
pnpm i
pnpm dev
```