diff --git a/docs/setup/clients/index.md b/docs/setup/clients/index.md index c93c1e7..dc997a0 100644 --- a/docs/setup/clients/index.md +++ b/docs/setup/clients/index.md @@ -14,13 +14,13 @@ or you can use it to connect to your own by editing your local storage to includ ```json { - "api": "https://staging.{{ project.domain }}/api/v9", - "cdn": "https://cdn.staging.{{ project.domain }}", - "gateway": "wss://gateway.staging.{{ project.domain }}", - "invite": "https://staging.{{ project.domain }}/invite", - "template": "https://staging.{{ project.domain }}/template", - "gift": "https://staging.{{ project.domain }}/gift", - "scheduledEvent": "https://staging.{{ project.domain }}/events" + "api": "https://staging.{{ project.domain }}/api/v9", + "cdn": "https://cdn.staging.{{ project.domain }}", + "gateway": "wss://gateway.staging.{{ project.domain }}", + "invite": "https://staging.{{ project.domain }}/invite", + "template": "https://staging.{{ project.domain }}/template", + "gift": "https://staging.{{ project.domain }}/gift", + "scheduledEvent": "https://staging.{{ project.domain }}/events" } ``` @@ -31,9 +31,9 @@ Replace the above endpoints with your own. If your domain name is `https://whate ### Dependencies -- [Git](https://git-scm.com/) -- [NodeJS](https://nodejs.org). Version 16+ -- [yarn](https://yarnpkg.com/) (preferred) or npm +- [Git](https://git-scm.com/) +- [NodeJS](https://nodejs.org). Version 16+ +- [yarn](https://yarnpkg.com/) (preferred) or npm In your terminal: @@ -42,7 +42,7 @@ In your terminal: git clone {{ repositories.base_url }}/{{ repositories.client }}.git # Enter the cloned directory, switch branches to the one, which is actually being developed -cd {{ project.name.lower() }}-client; git switch dev/bare-rewrite +cd client; git switch dev/bare-rewrite # Install dependencies yarn install @@ -86,13 +86,13 @@ Files will be built to `web-build` To contribute: -- [Fork the repository]({{ repositories.base_url }}/{{ repositories.client }}/fork) -- Run the building instructions. -- Commit & Push. -- Pull Request & Done! +- [Fork the repository]({{ repositories.base_url }}/{{ repositories.client }}/fork) +- Run the building instructions. +- Commit & Push. +- Pull Request & Done! ### What can I contribute? -- "Core" features like settings, editing messages, dms, markdown rendering, etc. What do you think are basic features that you would want? Some of the GitHub Issues apply to this. -- Implementing other things like voice/video is fine too, though -- [This]({{ repositories.base_url }}/{{ repositories.client }}/issues/21) is a good starting point and lists the core features that are still missing from the client. +- "Core" features like settings, editing messages, dms, markdown rendering, etc. What do you think are basic features that you would want? Some of the GitHub Issues apply to this. +- Implementing other things like voice/video is fine too, though +- [This]({{ repositories.base_url }}/{{ repositories.client }}/issues/21) is a good starting point and lists the core features that are still missing from the client. diff --git a/docs/setup/server/index.md b/docs/setup/server/index.md index 92a91eb..80507ae 100644 --- a/docs/setup/server/index.md +++ b/docs/setup/server/index.md @@ -13,12 +13,12 @@ We do not recommend using Windows to run {{ project.name }}. ## Dependencies -- [Git](https://git-scm.com/) -- [NodeJS](https://nodejs.org). Version 16+ -- [Python](https://www.python.org/). Version 3+. Make sure this is executable via `python` in your terminal. +- [Git](https://git-scm.com/) +- [NodeJS](https://nodejs.org). Version 16+ +- [Python](https://www.python.org/). Version 3+. Make sure this is executable via `python` in your terminal. (See: `python-is-python3` package) -- On Linux: `gcc`/`g++`. Packaged with `build-essential` on Debian/Ubuntu and `base-devel` on Arch. -- On Windows: [Visual Studio](https://visualstudio.microsoft.com/) (**NOT** VSCode) with the `Desktop development with C++` package. +- On Linux: `gcc`/`g++`. Packaged with `build-essential` on Debian/Ubuntu and `base-devel` on Arch. +- On Windows: [Visual Studio](https://visualstudio.microsoft.com/) (**NOT** VSCode) with the `Desktop development with C++` package. You do not need the full Visual Studio install, the build tools are fine. ## Setup @@ -30,7 +30,7 @@ In your terminal: git clone {{ repositories.base_url }}/{{ repositories.server }}.git # Navigate to project root -cd {{ project.name.lower() }}-server +cd server # Install javascript packages npm i @@ -51,6 +51,6 @@ If you set up your server remotely, you can use `curl http://localhost:3001/api/ Well, now you can configure {{ project.name }} to your liking! -- [Skip to server configuration](configuration) -- [Skip to reverse proxy / SSL](reverseProxy.md) -- [Skip to security](security) +- [Skip to server configuration](configuration) +- [Skip to reverse proxy / SSL](reverseProxy.md) +- [Skip to security](security)