From 26f006e5906bce27da2137740da656c9e6291805 Mon Sep 17 00:00:00 2001 From: bitfl0wer Date: Fri, 17 Mar 2023 12:39:58 +0100 Subject: [PATCH 1/6] Update gitignore to exclude venv --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index e0657c9..3be8ef1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ site/ .DS_STORE +./venv/* From 6cd537ca49f932927c0dac0d73601557b3bd1ee5 Mon Sep 17 00:00:00 2001 From: Florian Weber Date: Sat, 18 Mar 2023 11:49:22 +0100 Subject: [PATCH 2/6] Add client documentation --- docs/setup/clients/index.md | 77 +++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 docs/setup/clients/index.md diff --git a/docs/setup/clients/index.md b/docs/setup/clients/index.md new file mode 100644 index 0000000..8d19ff8 --- /dev/null +++ b/docs/setup/clients/index.md @@ -0,0 +1,77 @@ +# Clients + +!!! note "The Fosscord client is, at the time of writing this (March 17th, 2023), under heavy development and not ready to be used in production just yet." + +!!! note "Windows support is currently broken." + +The official Fosscord client is currently being developed at [this repository](https://github.com/fosscord/fosscord-client/tree/dev/bare-rewrite). + +## Dependencies + +- [Git](https://git-scm.com/) +- [NodeJS](https://nodejs.org). Version 16+ +- [yarn](https://yarnpkg.com/) (preferred) or npm + +## Setup/Building + +In your terminal: + +```bash +# Download Fosscord Client +git clone https://github.com/fosscord/fosscord-client.git + +# Enter the cloned directory, switch branches to the one, which is actually being developed +cd fosscord-client; git switch dev/bare-rewrite + +# Install dependencies +yarn install +``` + +To start the client with Metro for development, run + +```bash +yarn start +``` + +!!! note "Platform-specific development commands:" + + For development for Android, run + + ```bash + yarn android + ``` + + For development for iOS, run + + ```bash + yarn ios + ``` + + For development for Windows, run + + ```bash + yarn windows + ``` + +To build static files for the web, run + +```bash +yarn build:web +``` + +Files will be built to `web-build` + +## Contributing + +To contribute: + +- [Fork the repository](https://github.com/fosscord/fosscord-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](https://github.com/fosscord/fosscord-client/issues/21) is a good starting point and lists all things that are still missing from the client. From a4ecb5e5de84d2cc2d9030900eaa3c2839f7aa13 Mon Sep 17 00:00:00 2001 From: Florian Weber Date: Sat, 18 Mar 2023 11:49:44 +0100 Subject: [PATCH 3/6] Add venv/ to .gitignore --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 3be8ef1..55a30da 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ site/ .DS_STORE -./venv/* +venv/ From 6b21458e74de485c6ea459d4240e29eb65100013 Mon Sep 17 00:00:00 2001 From: Florian Weber Date: Sat, 18 Mar 2023 11:53:24 +0100 Subject: [PATCH 4/6] Add client-questions to FAQ --- docs/faq.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/faq.md b/docs/faq.md index cabc58d..fb4a77d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,15 @@ # Frequently Asked Questions +??? info "How do you use the Client?" + + As described in [Clients](/setup/clients), the official client is not ready yet. You are free to use + a Fosscord compatible client to connect, but no support will be provided. + +??? info "I am getting the error 'Cannot GET /', how fix?" + + If you see that error message, it means that your server is configured correctly. Hooray! + Unfortunately, our official client isn't done yet (see question above). + ??? info "Voice/Video when?" Currently there is no voice or video support in any Fosscord instance. From ef009b6aca8e0ae3ba6ecd7fff5f542380eb2f92 Mon Sep 17 00:00:00 2001 From: Florian Weber Date: Sat, 18 Mar 2023 11:55:19 +0100 Subject: [PATCH 5/6] prettier --- docs/setup/clients/index.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/setup/clients/index.md b/docs/setup/clients/index.md index 8d19ff8..1388a27 100644 --- a/docs/setup/clients/index.md +++ b/docs/setup/clients/index.md @@ -8,9 +8,9 @@ The official Fosscord client is currently being developed at [this repository](h ## 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 ## Setup/Building @@ -65,13 +65,13 @@ Files will be built to `web-build` To contribute: -- [Fork the repository](https://github.com/fosscord/fosscord-client/fork) -- Run the building instructions. -- Commit & Push. -- Pull Request & Done! +- [Fork the repository](https://github.com/fosscord/fosscord-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](https://github.com/fosscord/fosscord-client/issues/21) is a good starting point and lists all things 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](https://github.com/fosscord/fosscord-client/issues/21) is a good starting point and lists all things that are still missing from the client. From 24378b8adc01ac7189ac757f16b192eb86759b2e Mon Sep 17 00:00:00 2001 From: Madeline <46743919+MaddyUnderStars@users.noreply.github.com> Date: Sun, 19 Mar 2023 22:03:49 +1100 Subject: [PATCH 6/6] Add notes for using the official host --- docs/faq.md | 5 ---- docs/setup/clients/index.md | 32 +++++++++++++++++++----- docs/setup/server/migatingFromStaging.md | 2 +- 3 files changed, 27 insertions(+), 12 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index fb4a77d..4e4e426 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -5,11 +5,6 @@ As described in [Clients](/setup/clients), the official client is not ready yet. You are free to use a Fosscord compatible client to connect, but no support will be provided. -??? info "I am getting the error 'Cannot GET /', how fix?" - - If you see that error message, it means that your server is configured correctly. Hooray! - Unfortunately, our official client isn't done yet (see question above). - ??? info "Voice/Video when?" Currently there is no voice or video support in any Fosscord instance. diff --git a/docs/setup/clients/index.md b/docs/setup/clients/index.md index 1388a27..1a07ae6 100644 --- a/docs/setup/clients/index.md +++ b/docs/setup/clients/index.md @@ -2,18 +2,38 @@ !!! note "The Fosscord client is, at the time of writing this (March 17th, 2023), under heavy development and not ready to be used in production just yet." -!!! note "Windows support is currently broken." +!!! warning "Windows support is currently broken." The official Fosscord client is currently being developed at [this repository](https://github.com/fosscord/fosscord-client/tree/dev/bare-rewrite). -## Dependencies +## Official host + +We currently host the client at [https://app.fosscord.com](https://app.fosscord.com). +You can use it to connect to our official instance by default, +or you can use it to connect to your own by editing your local storage to include the `routeSettings` key with the below example content: +```json +{ + "api":"https://staging.fosscord.com/api/v9", + "cdn":"https://cdn.staging.fosscord.com", + "gateway":"wss://gateway.staging.fosscord.com", + "invite":"https://staging.fosscord.com/invite", + "template":"https://staging.fosscord.com/template", + "gift":"https://staging.fosscord.com/gift", + "scheduledEvent":"https://staging.fosscord.com/events" +} +``` + +Replace the above endpoints with your own. If your domain name is `https://whatever.notasite`, then you'll most likely want to enter +`https://whatever.noasite/api/v9` for the API endpoint, etc. + +## Setup/Building + +### Dependencies - [Git](https://git-scm.com/) - [NodeJS](https://nodejs.org). Version 16+ - [yarn](https://yarnpkg.com/) (preferred) or npm -## Setup/Building - In your terminal: ```bash @@ -53,7 +73,7 @@ yarn start yarn windows ``` -To build static files for the web, run +To build static files for the web (i.e. when hosting it yourself), run ```bash yarn build:web @@ -74,4 +94,4 @@ To 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](https://github.com/fosscord/fosscord-client/issues/21) is a good starting point and lists all things that are still missing from the client. +- [This](https://github.com/fosscord/fosscord-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/migatingFromStaging.md b/docs/setup/server/migatingFromStaging.md index 54e8ee9..b5f902d 100644 --- a/docs/setup/server/migatingFromStaging.md +++ b/docs/setup/server/migatingFromStaging.md @@ -3,7 +3,7 @@ 'Staging' refers to [this branch](https://github.com/fosscord/fosscord-server/tree/staging) of fosscord-server, which is deprecated in favour of [the refactor branch](https://github.com/fosscord/fosscord-server/tree/maddy/refactor) (if this is a 404, its just become the main branch now). -!!! warn "If you were using SQLite, you will be unable to migrate to the new version. SQLite is primarily for testing and development purposes, and it should not be used for production." +!!! warning "If you were using SQLite, you will be unable to migrate to the new version. SQLite is primarily for testing and development purposes, and it should not be used for production." To migrate from Staging: