CQ2 is a document collaboration tool, designed for thoughtfulness and coherence. Learn more.

Important

CQ2 is under active development, and is currently in alpha.

Get in touch

If you have suggestions for how CQ2 could be improved, please add your thoughts here or start a new discussion. If you have any questions, we would love to hear them too! If you want to report an issue, check if the issue is already opened here otherwise open a new one.

Self-hosting

Docker

Coming soon.

Vercel and MongoDB Atlas

CQ2 is built with MongoDB and Next.js, so for a quick and free setup, you can use a free MongoDB Atlas cluster and Vercel's hobby plan.

You can get started with MongoDB Atlas for free here. Make sure to add all IP addresses (0.0.0.0/0) to the IP access list of your Atlas cluster since it is not possible to determine the IP addresses of Vercel deployments.

You can get started with Vercel's hobby plan for free:

1. Fork this repo to your own GitHub account
2. Go to https://vercel.com/dashboard
3. Create a new project
4. Import your forked repository
5. Set the environment variables (according to the instructions in .env.example)
6. Deploy

Contributing

Development

First, make sure you have Node.js and MongoDB installed. Then, to develop locally:

1. Fork this repo to your own GitHub account and then clone it.

   git clone https://github.com/<your-username>/CQ2.git

2. Go to the project folder

   cd CQ2

3. Create a new branch:

   git checkout -b MY_BRANCH_NAME

4. Install the dependencies with:

   npm i

5. Copy .env.example to .env

   cp .env.example .env

6. Set the env variables according to the instructions in the .env file

7. Start developing and watch for code changes:

   npm run dev

8. Please make sure that you can make a full production build before opening a PR. You can build the project with:

   npm run build

License

CQ2 is distributed under the AGPLv3 license.