|
@@ -2,13 +2,8 @@
|
|
|
|
|
|
<img src="https://static.requarks.io/logo/wikijs-full.svg" alt="Wiki.js" width="600" />
|
|
|
|
|
|
-[](https://github.com/Requarks/wiki/releases)
|
|
|
[](https://github.com/requarks/wiki/blob/master/LICENSE)
|
|
|
[](http://standardjs.com/)
|
|
|
-[](https://github.com/Requarks/wiki/releases)
|
|
|
-[](https://hub.docker.com/r/requarks/wiki/)
|
|
|
-[](https://github.com/Requarks/wiki/actions/workflows/build.yml)
|
|
|
-[](https://huntr.dev/bounties/disclose)
|
|
|
[](https://github.com/users/NGPixel/sponsorship)
|
|
|
[](https://opencollective.com/wikijs)
|
|
|
[](https://wiki.requarks.io/slack)
|
|
@@ -16,412 +11,135 @@
|
|
|
[](https://www.reddit.com/r/wikijs/)
|
|
|
[](https://blog.js.wiki/subscribe)
|
|
|
|
|
|
-##### A modern, lightweight and powerful wiki app built on NodeJS
|
|
|
+##### Next Generation Open Source Wiki
|
|
|
|
|
|
</div>
|
|
|
|
|
|
-- **[Official Website](https://js.wiki/)**
|
|
|
-- **[Documentation](https://docs.requarks.io/)**
|
|
|
-- [Requirements](https://docs.requarks.io/install/requirements)
|
|
|
-- [Installation](https://docs.requarks.io/install)
|
|
|
-- [Demo](https://docs.requarks.io/demo)
|
|
|
-- [Changelog](https://docs.requarks.io/releases)
|
|
|
-- [Feature Requests](https://feedback.js.wiki/wiki)
|
|
|
-- [Chat with us on Slack](https://wiki.requarks.io/slack)
|
|
|
-- [Translations](https://docs.requarks.io/dev/translations) *(We need your help!)*
|
|
|
-- [E2E Testing Results](https://dashboard.cypress.io/projects/r7qxah/runs)
|
|
|
-- [Special Thanks](#special-thanks)
|
|
|
-- [Contribute](#contributors)
|
|
|
+- **[Official Website](https://next.js.wiki/)**
|
|
|
+- **[Documentation](https://next.js.wiki/docs/)**
|
|
|
|
|
|
-[Follow our Twitter feed](https://twitter.com/requarks) to learn about upcoming updates and new releases!
|
|
|
+:warning: :warning: **THIS IS A VERY BUGGY, INCOMPLETE AND NON-SECURE DEVELOPMENT BRANCH! USE AT YOUR OWN RISK! THERE'S NO UPGRADE PATH FROM THIS BUILD.** :warning: :warning:
|
|
|
|
|
|
-<h2 align="center">Donate</h2>
|
|
|
+The current stable release (2.x) is available at https://js.wiki
|
|
|
|
|
|
-<div align="center">
|
|
|
+---
|
|
|
|
|
|
-Wiki.js is an open source project that has been made possible due to the generous contributions by community [backers](https://wiki.js.org/about). If you are interested in supporting this project, please consider [becoming a sponsor](https://github.com/users/NGPixel/sponsorship), [becoming a patron](https://www.patreon.com/requarks), donating to our [OpenCollective](https://opencollective.com/wikijs), via [Paypal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FLV5X255Z9CJU&source=url) or via Ethereum (`0xe1d55c19ae86f6bcbfb17e7f06ace96bdbb22cb5`).
|
|
|
-
|
|
|
- [](https://github.com/users/NGPixel/sponsorship)
|
|
|
- [](https://www.patreon.com/requarks)
|
|
|
- [](https://opencollective.com/wikijs)
|
|
|
- [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FLV5X255Z9CJU&source=url)
|
|
|
- [](https://etherscan.io/address/0xe1d55c19ae86f6bcbfb17e7f06ace96bdbb22cb5)
|
|
|
- [](https://checkout.opennode.com/p/2553c612-f863-4407-82b3-1a7685268747)
|
|
|
- [](https://wikijs.threadless.com)
|
|
|
+## Requirements
|
|
|
|
|
|
-</div>
|
|
|
+- Node.js **18.x** or later
|
|
|
+- Yarn
|
|
|
+- PostgreSQL **11** or later
|
|
|
|
|
|
-<h2 align="center">Gold Tier Sponsors</h2>
|
|
|
+## Setup
|
|
|
|
|
|
-<div align="center">
|
|
|
-<table>
|
|
|
- <tbody>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle" width="444">
|
|
|
- <a href="https://trans-zero.com/" target="_blank">
|
|
|
- <img src="https://cdn.js.wiki/images/sponsors/transzero.png">
|
|
|
- </a>
|
|
|
- </td>
|
|
|
- </tr>
|
|
|
- </tbody>
|
|
|
-</table>
|
|
|
-</div>
|
|
|
+1. Clone the project
|
|
|
+1. Make a copy of `config.sample.yml` and rename it to `config.yml`
|
|
|
+1. Edit `config.yml` and fill in the database details. **You need an empty PostgreSQL database.**
|
|
|
+1. Run the following commands to install dependencies and generate the client assets:
|
|
|
+ ```sh
|
|
|
+ yarn
|
|
|
+ yarn legacy:build
|
|
|
+ cd ux
|
|
|
+ yarn
|
|
|
+ yarn build
|
|
|
+ cd ..
|
|
|
+ ```
|
|
|
+1. Run this command to start the server:
|
|
|
+ ```sh
|
|
|
+ node server
|
|
|
+ ```
|
|
|
+1. In your browser, navigate to `http://localhost:3000` *(or the IP/hostname of the server and the PORT you defined earlier.)*
|
|
|
+1. Login using the default administrator user:
|
|
|
+ - Email: `admin@example.com`
|
|
|
+ - Password: `12345678`
|
|
|
|
|
|
-<h2 align="center">GitHub Sponsors</h2>
|
|
|
+> **DO NOT** report bugs. This build is **VERY** buggy and **VERY** incomplete. Absolutely **NO** support is provided either.
|
|
|
|
|
|
-Support this project by becoming a sponsor. Your name will show up in the Contribute page of all Wiki.js installations as well as here with a link to your website! [[Become a sponsor](https://github.com/users/NGPixel/sponsorship)]
|
|
|
+## Using VS Code Dev Environment
|
|
|
|
|
|
-<div align="center">
|
|
|
-<table>
|
|
|
- <tbody>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle" width="444">
|
|
|
- <a href="https://www.stellarhosted.com/" target="_blank">
|
|
|
- <img src="https://cdn.js.wiki/images/sponsors/stellarhosted.png">
|
|
|
- </a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle" width="444">
|
|
|
- <a href="https://www.hostwiki.com/" target="_blank">
|
|
|
- <img src="https://cdn.js.wiki/images/sponsors/hostwiki.png">
|
|
|
- </a>
|
|
|
- </td>
|
|
|
- </tr>
|
|
|
- </tbody>
|
|
|
-</table>
|
|
|
-</div>
|
|
|
+### Requirements
|
|
|
|
|
|
-<div align="center">
|
|
|
-<table>
|
|
|
- <tbody>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle" width="148">
|
|
|
- <a href="https://github.com/alexksso" target="_blank">
|
|
|
- Alexander Casassovici<br />(@alexksso)
|
|
|
- </a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle" width="148">
|
|
|
- <a href="https://github.com/broxen" target="_blank">
|
|
|
- Broxen<br />(@broxen)
|
|
|
- </a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle" width="148">
|
|
|
- <a href="https://github.com/xDacon" target="_blank">
|
|
|
- Dacon<br />(@xDacon)
|
|
|
- </a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle" width="148">
|
|
|
- <a href="https://github.com/GigabiteLabs" target="_blank">
|
|
|
- <img src="https://static.requarks.io/sponsors/gigabitelabs-148x129.png">
|
|
|
- </a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle" width="148">
|
|
|
- <a href="https://github.com/JayDaley" target="_blank">
|
|
|
- Jay Daley<br />(@JayDaley)
|
|
|
- </a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle" width="148">
|
|
|
- <a href="https://github.com/idokka" target="_blank">
|
|
|
- Oleksii<br />(@idokka)
|
|
|
- </a>
|
|
|
- </td>
|
|
|
- <!--<td align="center" valign="middle" width="148">
|
|
|
- <a href="https://github.com/sponsors/NGPixel" target="_blank">
|
|
|
- <img src="https://static.requarks.io/sponsors/become-148x72.png">
|
|
|
- </a>
|
|
|
- </td>-->
|
|
|
- </tr>
|
|
|
- </tbody>
|
|
|
-</table>
|
|
|
-
|
|
|
-<table><tbody><tr><td>
|
|
|
-<img width="441" height="1" />
|
|
|
-
|
|
|
-- Akira Suenami ([@a-suenami](https://github.com/a-suenami))
|
|
|
-- Arnaud Marchand ([@snuids](https://github.com/snuids))
|
|
|
-- Brian Douglass ([@bhdouglass](https://github.com/bhdouglass))
|
|
|
-- Bryon Vandiver ([@asterick](https://github.com/asterick))
|
|
|
-- Cameron Steele ([@ATechAdventurer](https://github.com/ATechAdventurer))
|
|
|
-- Cloud Data Hosting LLC ([@CloudDataHostingLLC](https://github.com/CloudDataHostingLLC))
|
|
|
-- CrazyMarvin ([@CrazyMarvin](https://github.com/CrazyMarvin))
|
|
|
-- David Christian Holin ([@SirGibihm](https://github.com/SirGibihm))
|
|
|
-- Dragan Espenschied ([@despens](https://github.com/despens))
|
|
|
-- Elijah Zobenko ([@he110](https://github.com/he110))
|
|
|
-- Ernie ([@iamernie](https://github.com/iamernie))
|
|
|
-- Fabio Ferrari ([@devxops](https://github.com/devxops))
|
|
|
-- Finsa S.p.A. ([@finsaspa](https://github.com/finsaspa))
|
|
|
-- Florian Moss ([@florianmoss](https://github.com/florianmoss))
|
|
|
-- GoodCorporateCitizen ([@GoodCorporateCitizen](https://github.com/GoodCorporateCitizen))
|
|
|
-- HeavenBay ([@HeavenBay](https://github.com/heavenbay))
|
|
|
-- Ian Hyzy ([@ianhyzy](https://github.com/ianhyzy))
|
|
|
-- Jaimyn Mayer ([@jabelone](https://github.com/jabelone))
|
|
|
-- Jay Lee ([@polyglotm](https://github.com/polyglotm))
|
|
|
-- Kelly Wardrop ([@dropcoded](https://github.com/dropcoded))
|
|
|
-- Loki ([@binaryloki](https://github.com/binaryloki))
|
|
|
-- MaFarine ([@MaFarine](https://github.com/MaFarine))
|
|
|
-- Marcilio Leite Neto ([@marclneto](https://github.com/marclneto))
|
|
|
-
|
|
|
-</td><td>
|
|
|
-<img width="441" height="1" />
|
|
|
-
|
|
|
-- Mattias Johnson ([@mattiasJohnson](https://github.com/mattiasJohnson))
|
|
|
-- Max Ricketts-Uy ([@MaxRickettsUy](https://github.com/MaxRickettsUy))
|
|
|
-- Mitchell Rowton ([@mrowton](https://github.com/mrowton))
|
|
|
-- M. Scott Ford ([@mscottford](https://github.com/mscottford))
|
|
|
-- Nick Halase ([@nhalase](https://github.com/nhalase))
|
|
|
-- Nina Reynolds ([@cutecycle](https://github.com/cutecycle))
|
|
|
-- Noel Cower ([@nilium](https://github.com/nilium))
|
|
|
-- Philipp Schmitt ([@pschmitt](https://github.com/pschmitt))
|
|
|
-- Robert Lanzke ([@winkelement](https://github.com/winkelement))
|
|
|
-- Sam Martin ([@ABitMoreDepth](https://github.com/ABitMoreDepth))
|
|
|
-- Sean Coffey ([@seanecoffey](https://github.com/seanecoffey))
|
|
|
-- Stephan Kristyn ([@stevek-pro](https://github.com/stevek-pro))
|
|
|
-- Theodore Chu ([@TheodoreChu](https://github.com/TheodoreChu))
|
|
|
-- Tyler Denman ([@tylerguy](https://github.com/tylerguy))
|
|
|
-- Victor Bilgin ([@vbilgin](https://github.com/vbilgin))
|
|
|
-- VMO Solutions ([@vmosolutions](https://github.com/vmosolutions))
|
|
|
-- aniketpanjwani ([@aniketpanjwani](https://github.com/aniketpanjwani))
|
|
|
-- aytaa ([@aytaa](https://github.com/aytaa))
|
|
|
-- magicpotato ([@fortheday](https://github.com/fortheday))
|
|
|
-- motoacs ([@motoacs](https://github.com/motoacs))
|
|
|
-- rburckner ([@rburckner](https://github.com/rburckner))
|
|
|
-- scorpion ([@scorpion](https://github.com/scorpion))
|
|
|
-- valantien ([@valantien](https://github.com/valantien))
|
|
|
-
|
|
|
-</td></tr></tbody></table>
|
|
|
-</div>
|
|
|
+- VS Code
|
|
|
+- Docker Desktop
|
|
|
+- **Windows-only:** WSL 2 + WSL Integration enabled in Docker Desktop
|
|
|
|
|
|
-<h2 align="center">OpenCollective Sponsors</h2>
|
|
|
+### Usage
|
|
|
|
|
|
-Support this project by becoming a sponsor. Your logo will show up in the Contribute page of all Wiki.js installations as well as here with a link to your website! [[Become a sponsor](https://opencollective.com/wikijs#sponsor)]
|
|
|
+1. Clone the project
|
|
|
+1. Open the project in VS Code
|
|
|
+1. Make sure you have **Dev Containers** extension installed. (On Windows, you need the **WSL** VS Code extension as well.)
|
|
|
+1. Reopen the project in container (from the popup in the lower-right corner of the screen when opening the project, or via the Command Palette (Ctrl+Shift+P) afterwards).
|
|
|
+1. Once in container mode, run the task "Create terminals" from the Command Palette:
|
|
|
+ - Launch the Command Palette (Ctrl+Shift+P)
|
|
|
+ - Type "Run Task" and press Enter
|
|
|
+ - Select the task "Create terminals" and press Enter
|
|
|
+1. Two terminals will launch in split-screen mode at the bottom of the screen. **Server** on the left and **UX** on the right.
|
|
|
+1. In the left-side terminal (Server), run the command:
|
|
|
+ ```sh
|
|
|
+ yarn legacy:build
|
|
|
+ ```
|
|
|
+1. In the right-side terminal (UX), run the command:
|
|
|
+ ```sh
|
|
|
+ yarn build
|
|
|
+ ```
|
|
|
+1. Back in the left-side terminal (Server), run the command:
|
|
|
+ ```sh
|
|
|
+ yarn dev
|
|
|
+ ```
|
|
|
+1. Open your browser to `http://localhost:3000`
|
|
|
+1. Login using the default administrator user:
|
|
|
+ - Email: `admin@example.com`
|
|
|
+ - Password: `12345678`
|
|
|
|
|
|
-<div align="center">
|
|
|
-<table>
|
|
|
- <tbody>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/0/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/0/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/1/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/1/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/2/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/2/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/3/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/3/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/4/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/4/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- </tr>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/5/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/5/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/6/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/6/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/7/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/7/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/8/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/8/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/9/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/9/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- </tr>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/10/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/10/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/11/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/11/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/12/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/12/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/13/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/13/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/14/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/14/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- </tr>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/15/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/15/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/16/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/16/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/17/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/17/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/18/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/18/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/19/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/19/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- </tr>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/20/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/20/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/21/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/21/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/22/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/22/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/23/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/23/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/24/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/24/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- </tr>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/25/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/25/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/26/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/26/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/27/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/27/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/28/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/28/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/29/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/29/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- </tr>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/30/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/30/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/31/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/31/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/32/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/32/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/33/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/33/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/34/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/34/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- </tr>
|
|
|
- <tr>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/35/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/35/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/36/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/36/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/37/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/37/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/38/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/38/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- <td align="center" valign="middle">
|
|
|
- <a href="https://opencollective.com/wikijs/sponsor/39/website" target="_blank"><img src="https://opencollective.com/wikijs/sponsor/39/avatar.svg"></a>
|
|
|
- </td>
|
|
|
- </tr>
|
|
|
- </tbody>
|
|
|
-</table>
|
|
|
-</div>
|
|
|
+> **DO NOT** report bugs. This build is **VERY** buggy and **VERY** incomplete. Absolutely **NO** support is provided either.
|
|
|
|
|
|
-<h2 align="center">Patreon Backers</h2>
|
|
|
+### Server Development
|
|
|
|
|
|
-Thank you to all our patrons! 🙏 [[Become a patron](https://www.patreon.com/requarks)]
|
|
|
+From the left-side terminal (Server), run the command:
|
|
|
|
|
|
-<div align="center">
|
|
|
-<table><tbody><tr><td>
|
|
|
-<img width="441" height="1" />
|
|
|
-
|
|
|
-- Al Romano
|
|
|
-- Alex Balabanov
|
|
|
-- Alex Zen
|
|
|
-- Arti Zirk
|
|
|
-- Brandon Curtis
|
|
|
-- Dave 'Sri' Seah
|
|
|
-- djagoo
|
|
|
-- Douglas Lassance
|
|
|
-- Ernie Reid
|
|
|
-- Etienne
|
|
|
-- Flemis Jurgenheimer
|
|
|
-- Florent
|
|
|
-- Günter Pavlas
|
|
|
-- hong
|
|
|
-- Hope
|
|
|
-- Ian
|
|
|
-
|
|
|
-</td><td>
|
|
|
-<img width="441" height="1" />
|
|
|
-
|
|
|
-- Iskander Callos
|
|
|
-- Josh Stewart
|
|
|
-- Justin Dunsworth
|
|
|
-- Keir
|
|
|
-- Loïc CRAMPON
|
|
|
-- Ludgeir Ibanez
|
|
|
-- Mark Mansur
|
|
|
-- Matt Gedigian
|
|
|
-- Patryk
|
|
|
-- Philipp Schürch
|
|
|
-- Tracey Duffy
|
|
|
-- Richeir
|
|
|
-- Shad Narcher
|
|
|
-- SmartNET.works
|
|
|
-- Stepan Sokolovskyi
|
|
|
-- Zach Maynard
|
|
|
-- 张白驹
|
|
|
-
|
|
|
-</td></tr></tbody></table>
|
|
|
-</div>
|
|
|
+```sh
|
|
|
+yarn dev
|
|
|
+```
|
|
|
+
|
|
|
+This will launch the server and automatically restart upon modification of any server files.
|
|
|
+
|
|
|
+Only precompiled client assets are served in this mode. See the sections below on how to modify the frontend and run in SPA (Single Page Application) mode.
|
|
|
|
|
|
-<h2 align="center">OpenCollective Backers</h2>
|
|
|
+### Frontend Development (Quasar/Vue 3)
|
|
|
|
|
|
-Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/wikijs#backer)]
|
|
|
+> Make sure you are running `yarn dev` in the left-side terminal (Server) first! Requests still need to be forwarded to the server, even in SPA mode!
|
|
|
|
|
|
-<a href="https://opencollective.com/wikijs#backers" target="_blank"><img src="https://opencollective.com/wikijs/backers.svg?width=890"></a>
|
|
|
+If you wish to modify any frontend content (under `/ux`), you need to start the Quasar Dev Server in the right-side terminal (UX):
|
|
|
|
|
|
-<h2 align="center">Contributors</h2>
|
|
|
+```sh
|
|
|
+yarn dev
|
|
|
+```
|
|
|
|
|
|
-This project exists thanks to all the people who contribute. [[Contribute]](https://github.com/Requarks/wiki/blob/master/.github/CONTRIBUTING.md).
|
|
|
-<a href="https://github.com/Requarks/wiki/graphs/contributors"><img src="https://opencollective.com/wikijs/contributors.svg?width=890" /></a>
|
|
|
+You can then access the site at `http://localhost:3001`. Notice the port being `3001` rather than `3000`. The app runs in a SPA (single-page application) mode and automatically hot-reload any modified component. Any requests made to the `/graphql` endpoint are automatically forwarded to the server running on port `3000`, which is why both must be running at the same time.
|
|
|
|
|
|
-<h2 align="center">Special Thanks</h2>
|
|
|
+Note that not all sections/features are available from this mode, notably the page editing features which still relies on the old client code (Vuetify/Vue 2). For example, trying to edit a page will simply not work. You must use the normal mode (port 3000) to edit pages as it relies on legacy client code. As more features gets ported / developed for Vue 3, they will become available in the SPA mode.
|
|
|
|
|
|
-
|
|
|
-[Algolia](https://www.algolia.com/) for providing access to their incredible search engine.
|
|
|
+Any change you make to the frontend will not be reflected on port 3000 until you run the command `yarn build` in the right-side terminal.
|
|
|
|
|
|
-
|
|
|
-[Browserstack](https://www.browserstack.com/) for providing access to their great cross-browser testing tools.
|
|
|
+### Legacy Frontend Development (Vuetify/Vue 2)
|
|
|
|
|
|
-
|
|
|
-[Cloudflare](https://www.cloudflare.com/) for providing their great CDN, SSL and advanced networking services.
|
|
|
+Client code from Wiki.js 2.x is located under `/client`. Some sections still rely on this legacy code (notably the page editing features). Code is gradually being removed from this location and replaced with newer code in `/ux`.
|
|
|
|
|
|
-
|
|
|
-[DigitalOcean](https://m.do.co/c/5f7445bfa4d0) for providing hosting of the Wiki.js documentation site.
|
|
|
+In the unlikely event that you need to modify legacy code and regenerate the old client files, you can do so by running in this command in the left-side terminal (Server):
|
|
|
+```sh
|
|
|
+yarn legacy:build
|
|
|
+```
|
|
|
|
|
|
-
|
|
|
-[Icons8](https://icons8.com/) for providing beautiful icon sets.
|
|
|
+Then run `yarn dev` to start the server again.
|
|
|
|
|
|
-
|
|
|
-[Lokalise](https://lokalise.com/) for providing access to their great localization tool.
|
|
|
+### pgAdmin
|
|
|
|
|
|
-
|
|
|
-[Netlify](https://www.netlify.com) for providing hosting for landings and blog websites.
|
|
|
+A web version of pgAdmin (a PostgreSQL administration tool) is available at `http://localhost:8000`. Use the login `dev` / `123123` to login.
|
|
|
|
|
|
-
|
|
|
-[ngrok](https://ngrok.com) for providing access to their great HTTP tunneling services.
|
|
|
+The server **dev** should already be available under **Servers**. If that's not the case, add a new one with the following settings:
|
|
|
|
|
|
-
|
|
|
-[Porkbun](https://www.porkbun.com) for providing domain registration services.
|
|
|
+- Hostname: `db`
|
|
|
+- Port: `5432`
|
|
|
+- Username: `postgres`
|
|
|
+- Password: `postgres`
|
|
|
+- Database: `postgres`
|