Skip to content

docs-plus/docs.plus

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

📚Docs.plus

Generic badge Apache License PRs Welcome

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.

🚀 Quick Start

Prerequisites:

Docs.plus is organized as a monorepo and uses Yarn Workspaces for managing dependencies and synchronizing versions across different packages.

🛠 Setting Up Your Development Environment

Follow these steps to get started with Docs.plus:

# Clone the repository
$ git clone https://github.com/docs-plus/docs.plus.git

# Navigate to the project directory
$ cd docs.plus

# Install dependencies
$ yarn

PostgreSQL Database Setup

Set up a PostgreSQL database accessible to your development environment. If using Docker, here's a basic command to start a PostgreSQL container:

docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d postgres

More details on the PostgreSQL Docker image are available in the official Docker documentation.

Running the Project

Unix-based systems (macOS, Linux):

./run_dev.sh

Windows systems: Ensure PowerShell is installed. Then, to start the development servers, open three separate PowerShell windows and run the following commands:

# PowerShell Window 1
cd .\packages\hocuspocus.server\
npm run dev

# PowerShell Window 2
cd .\packages\hocuspocus.server\
npm run dev:ws

# PowerShell Window 3
cd .\packages\nextjs\
npm run dev

💡 We're actively seeking contributors to improve our Windows setup instructions. If you can assist, we'd be thrilled! Your contribution will enhance the accessibility of Docs.plus for Windows users and foster our community's growth. All collaboration is warmly welcomed!

📫 Connect With Us

We'd love to hear from you! Join our Discussions, or reach out through:

📜 License

Docs.plus is under the Apache License v2, granting you freedom to use, modify, distribute, and even sell your modifications under the same terms.

🙏 Support Our Project

Docs.plus is free and open-source. Keeping it running and

continuously improving requires resources. If you're able to support us, we'd greatly appreciate it:

Your support maintains our servers and enhances this platform for everyone's benefit. Thank you for your generosity!