docs.plus is a free, real-time collaboration tool built on open-source technologies. It empowers communities to share and organize information logically and hierarchically, making teamwork and knowledge sharing straightforward and effective.
Ensure you have the following installed:
>=18.15.0
)Follow these steps to set up your development environment:
Clone the Repository
git clone https://github.com/docs-plus/docs.plus.git
cd docs.plus
Install Dependencies
yarn
Install Supabase CLI
brew install supabase/tap/supabase
If you're using a different package manager, refer to the Supabase CLI installation guide.
Before starting the project, you need to create the .env
files by following these steps:
Locate the Example Files: You will find .env.example
files in the following directories:
packages/webapp/.env.example
packages/supabase/.env.example
packages/hocuspocus.server/.env.example
Create .env Files: Copy each .env.example
to a new .env
file in the same directory.
cp packages/webapp/.env.example packages/webapp/.env
cp packages/supabase/.env.example packages/supabase/.env
cp packages/hocuspocus.server/.env.example packages/hocuspocus.server/.env
Update Configurations: Edit the .env
files to replace placeholders with your actual configuration values.
You can set up PostgreSQL in your development environment by running the following Docker command:
docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d postgres
For more information on the PostgreSQL Docker image, refer to the official Docker documentation.
After setting up the environment and configuring the .env
files, you can start the project in development mode using:
make local
This command will start the development server for the webapp, as well as the backend services (hocuspocus
& supabase
).
For more details on available commands, refer to the Makefile.
We'd love to hear from you! You can reach out through the following channels:
docs.plus is licensed under the Apache License v2. You are free to use, modify, distribute, and even sell your modifications under the same terms.
docs.plus is a free and open-source project. To keep it running and continuously improving, we need your support. If you're able to contribute, we'd greatly appreciate it:
Your support helps maintain our servers and enhances the platform for everyone's benefit. Thank you for your generosity!