forked from will2hew/docmost
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
3 changed files
with
40 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,60 +1,35 @@ | ||
|
||
## Description | ||
WIP | ||
|
||
## Installation | ||
Make sure you have pnpm installed `npm install -g pnpm` | ||
|
||
```bash | ||
$ git clone https://github.com/docmost/docmost | ||
$ pnpm install | ||
``` | ||
|
||
## Running the app | ||
|
||
### Development | ||
|
||
#### Frontend | ||
```bash | ||
$ pnpm nx run client:dev | ||
``` | ||
#### Backend | ||
```bash | ||
# build extension package first | ||
$ nx run @docmost/editor-ext:build | ||
|
||
# development | ||
$ pnpm nx run server:start | ||
|
||
# watch mode | ||
$ pnpm nx run server:start:dev | ||
|
||
``` | ||
|
||
### Production | ||
```bash | ||
$ pnpm run build | ||
|
||
$ pnpm nx run server:start:prod | ||
``` | ||
The server will be available on `http://localhost:3000` | ||
|
||
## Migrations | ||
|
||
```bash | ||
# This creates a new empty migration file named 'init' | ||
$ pnpm nx run server:migration:create init | ||
|
||
# Generates 'init' migration file from existing entities to update the database schema | ||
$ pnpm nx run server:migration:generate init | ||
|
||
# Runs all pending migrations to update the database schema | ||
$ pnpm nx run server:migration:run | ||
|
||
# Reverts the last executed migration | ||
$ pnpm nx run server:migration:revert | ||
|
||
# Shows the list of executed and pending migrations | ||
$ pnpm nx run server:migration:show | ||
|
||
``` | ||
<div align="center"> | ||
<h1><b>Docmost</b></h1> | ||
<p> | ||
Open-source collaborative wiki and documentation software. | ||
<br /> | ||
<a href="https://docmost.com"><strong>Website</strong></a> | | ||
<a href="https://docmost.com/docs"><strong>Documentation</strong></a> | ||
</p> | ||
</div> | ||
<br /> | ||
|
||
> [!NOTE] | ||
> Docmost is currently in **beta**. We value your feedback as we progress towards a stable release. | ||
## Getting started | ||
To get started with Docmost, please refer to our [documentation](https://docmost.com/docs). | ||
|
||
## Features | ||
- Real-time collaboration | ||
- Spaces | ||
- Permissions management | ||
- Groups | ||
- Comments | ||
- Page history | ||
- Search | ||
- File attachment | ||
|
||
#### Screenshots | ||
<p align="center"> | ||
<img alt="home" src="https://docmost.com/screenshots/home.png" width="70%"> | ||
<img alt="editor" src="https://docmost.com/screenshots/editor.png" width="70%"> | ||
</p> | ||
|
||
### Contributing | ||
See the [development doc](https://docmost.com/docs/self-hosting/development) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters