Table of Contents
This is an example of how to list things you need to use the software and how to install them.
- NodeJs
- PostgreSQL
- Clone both the repositories
git clone https://github.com/qwikcollab/qwikcollab.git git clone https://github.com/qwikcollab/server.git
- Install NPM packages on both repositories, copy environment variables
cd qwikcollab npm install
cd server npm install cp .env.example .env
- Make sure you have a PostgreSQL database running, update DATABASE_URL accordingly in server .env
- Run prisma migration
npx prisma migrate dev
- Start em' all
cd qwikcollab npm run dev
cd server npm run start:dev
Contributions to the repository are welcome !!.
Contributions are welcome as the project needs a lot of improvements !!.
The project uses conventional commits for commit messages, make sure your
messages are in similar format. Before raising an MR, do format your
code using npm run format
.
Qwikcollab is a collaborative code editor, it helps multiple people on dfferent machines collaborate over a single document on a web page.
You can use qwikcollab to
- Take interviews
- Brainstorm with others over ideas
Qwikcollab uses operational transformation for managing document versions when
multiple people edit it, it uses codemirror
which is an extensible code editor package and also helps in
merging changes from different clients. The changes are transferred using websockets
.
Well collaborative editing isn't a new thing, this is similar to Google Docs, it started off with me experimenting with how collaborative editing works and eventually it turned into a project. Hopefully this repository will be helpful for people who want to learn how collaborative editing works
If you find any issues, feel free to reach out to me on twitter
@dumbbellcode
or linkedin @sudheer121
.