From 9c0bad3a09d170da8ab118462cf7c651c8fd8763 Mon Sep 17 00:00:00 2001 From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> Date: Tue, 2 Feb 2021 22:15:34 +0100 Subject: [PATCH 01/12] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 4f22aca..515ed42 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,9 @@ Discord Open Source aims to be a full one-on-one clone of Discord, adding more features that can be used as a replacement for the official client and still connect and host private Discord server instances. Discord Open Source aims to give the best possible user experience, while combining Discord's UI, features and adding new ones/improving old ones. +## Support +https://discord.gg/ZrnGQP6p3d +if we are finished we'll host our own instance. ## Get started From 232fa97bb6a857bd822a56b72b37b7c19c1630e1 Mon Sep 17 00:00:00 2001 From: Kamil G <59805849+mafineeek@users.noreply.github.com> Date: Wed, 3 Feb 2021 18:39:21 +0100 Subject: [PATCH 02/12] split server into gateway & api --- setup/setup.bat | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/setup/setup.bat b/setup/setup.bat index 5b66b86..b911155 100644 --- a/setup/setup.bat +++ b/setup/setup.bat @@ -5,12 +5,13 @@ ECHO v0.1 ~xnacly ECHO. ECHO str+c/str+d to exit ECHO 1: /discord-dashboard.git -ECHO 2: /discord-server.git +ECHO 2: /discord-api.git ECHO 3: /discord-cdn.git ECHO 4: /discord-client.git ECHO 5: /discord-react-native.git ECHO 6: /discord-react.git ECHO 7: /discord-css.git +ECHO 8: /discord-gateway.git ECHO A: all of the above ECHO. CHOICE /c 1234567a /m "decide what repos to install" @@ -30,7 +31,8 @@ cd .. mkdir discord-open-source-repos cd discord-open-source-repos git clone https://github.com/discord-open-source/discord-dashboard.git -git clone https://github.com/discord-open-source/discord-server.git +git clone https://github.com/discord-open-source/discord-api.git +git clone https://github.com/discord-open-source/discord-gateway.git git clone https://github.com/discord-open-source/discord-cdn.git git clone https://github.com/discord-open-source/discord-client.git git clone https://github.com/discord-open-source/discord-react-native.git From 7cb8a6d95091dff9350eccd4261b1b972d4abacf Mon Sep 17 00:00:00 2001 From: Kamil G <59805849+mafineeek@users.noreply.github.com> Date: Wed, 3 Feb 2021 18:59:50 +0100 Subject: [PATCH 03/12] Server split --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 515ed42..5881c15 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ | Repo name | Brief description | | :-------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- | | [CSS](https://github.com/discord-open-source/discord-css) | Unofficial css framework in the style of Discord. | -| [Server](https://github.com/discord-open-source/discord-server) | Discord-server for discord-client | +| [API](https://github.com/discord-open-source/discord-API) | Discord API server for discord-client | +| [Gateway](https://github.com/discord-open-source/discord-gateway) | Discord Gateway for discord-client | | [Dashboard](https://github.com/discord-open-source/discord-dashboard) | An admin dashboard for discord-server | | [Client](https://github.com/discord-open-source/discord-client) | Discord Client for discord-server | | [CDN](https://github.com/discord-open-source/discord-cdn) | [Content-delivery-network](https://www.cloudflare.com/learning/cdn/what-is-a-cdn/) for the server, used to store images and assets | From 37cb14ba0b7d93ae21442c9b0a90f6eac6d971a6 Mon Sep 17 00:00:00 2001 From: Kamil G <59805849+mafineeek@users.noreply.github.com> Date: Wed, 3 Feb 2021 19:15:30 +0100 Subject: [PATCH 04/12] contribution info update --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 5881c15..365ea61 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,4 @@ if we are finished we'll host our own instance. ``` ## Contribute +First of all, [read this issue](https://github.com/discord-open-source/discord-open-source/issues/10) From e876659b4b91687cd9613497caae25c0424fd9d2 Mon Sep 17 00:00:00 2001 From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> Date: Thu, 4 Feb 2021 11:02:07 +0100 Subject: [PATCH 05/12] :sparkles: bash setup script --- README.md | 2 +- setup/README.md | 14 ++++++++++++ setup/setup.sh | 57 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 setup/README.md create mode 100755 setup/setup.sh diff --git a/README.md b/README.md index 365ea61..d098baf 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ if we are finished we'll host our own instance. ## Get started ```bash ->>> git clone https://github.com/discord-open-source/discord-open-source.git +>>> git clone https://github.com/discord-open-source/discord-open-source.git discord-open-source >>> cd discord-open-source/setup >>> setup ``` diff --git a/setup/README.md b/setup/README.md new file mode 100644 index 0000000..f287bdb --- /dev/null +++ b/setup/README.md @@ -0,0 +1,14 @@ +## Getting Started +### Windows +Just double click setup.bat + +### Linux/MacOS +to execute the setup script you need to grant execution permission (+x). +To do that open your terminal and navigate to this directory ``setup/`` and enter this: +``` +chmod +x setup.sh +``` +and then execute by double clicking or entering this in the terminal: +``` +./setup.sh +``` \ No newline at end of file diff --git a/setup/setup.sh b/setup/setup.sh new file mode 100755 index 0000000..2913880 --- /dev/null +++ b/setup/setup.sh @@ -0,0 +1,57 @@ +echo -------------------------------------- +echo Discord Open Source Contribution Setup +echo strg+c/strg+d to exit +echo ------------------------------------------- +echo This will clone and setup all repositories, +echo if you only want to work on one specific repository +echo follow their specific Getting Started Guide and exit this script +echo ---------------------------------------------------------------- +echo "Are you sure you want to continue (y/n)?" +read -p "" CONT +if [ "$CONT" != "y" ]; then + echo Aborting setup + exit 1 +fi +echo --------------------- +echo Checking dependencies +if ! [ -x "$(command -v git)" ]; then + echo 'Error: git is not installed.' >&2 + echo Please Install git from: https://git-scm.com/downloads + echo And make sure its in the path + exit 1 +fi +if ! [ -x "$(command -v node)" ]; then + echo 'Error: node is not installed.' >&2 + echo Please Install NodeJS from: https://nodejs.org/en/download/ + echo And make sure its in the path + exit 1 +fi +if ! [ -x "$(command -v npm)" ]; then + echo 'Error: npm is not installed.' >&2 + echo Please install npm from: https://nodejs.org/en/download/ + echo And make sure its in the path + exit 1 +fi +echo ✓ All Dependencies Installed +echo ------------------------------- +echo Creating organization directory +cd ../../ +mv discord-open-source overview +mkdir discord-open-source +mv overview discord-open-source/ +cd discord-open-source +echo Cloning all repositories +git clone https://github.com/discord-open-source/discord-api api +git clone https://github.com/discord-open-source/discord-gateway gateway +git clone https://github.com/discord-open-source/discord-voice voice +git clone https://github.com/discord-open-source/discord-cdn cdn +git clone https://github.com/discord-open-source/discord-css design +git clone https://github.com/discord-open-source/discord-client client +git clone https://github.com/discord-open-source/discord-react react +git clone https://github.com/discord-open-source/discord-react-native react-native +git clone https://github.com/discord-open-source/discord-dashboard dashboard +if [ -x "$(command -v code)" ]; then + echo '{"folders":[{"path":"overview"},{"path":"cdn"},{"path":"api"},{"path":"gateway"},{"path":"voice"},{"path":"design"},{"path":"react"},{"path":"client"},{"path":"react-native"},{"path":"dashboard"}]}' >> discord-open-source.code-workspace + echo Open VSCode Workspace + code discord-open-source.code-workspace +fi From c68caa940d7e419ed6ba00ce4c6cd477521f686a Mon Sep 17 00:00:00 2001 From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> Date: Thu, 4 Feb 2021 16:26:04 +0100 Subject: [PATCH 06/12] :art: improve setup script --- setup/setup.bat | 87 ++++++++++++++++++++++++++++++++----------------- setup/setup.sh | 8 +++-- 2 files changed, 62 insertions(+), 33 deletions(-) diff --git a/setup/setup.bat b/setup/setup.bat index b911155..969d948 100644 --- a/setup/setup.bat +++ b/setup/setup.bat @@ -4,37 +4,64 @@ ECHO Discord-Open-Source-Installer ECHO v0.1 ~xnacly ECHO. ECHO str+c/str+d to exit -ECHO 1: /discord-dashboard.git -ECHO 2: /discord-api.git -ECHO 3: /discord-cdn.git -ECHO 4: /discord-client.git -ECHO 5: /discord-react-native.git -ECHO 6: /discord-react.git -ECHO 7: /discord-css.git -ECHO 8: /discord-gateway.git -ECHO A: all of the above ECHO. -CHOICE /c 1234567a /m "decide what repos to install" +ECHO This will clone and setup all repositories, +ECHO if you only want to work on one specific repository +ECHO follow their specific Getting Started Guide and exit this script +ECHO. +CHOICE /C YN /m "Are you sure you want to continue (y/n)?" +IF %ERRORLEVEL% == 2 GOTO :end +where /q git +IF ERRORLEVEL 1 ( + ECHO Error: git is not installed. + ECHO Please Install git from: https://git-scm.com/downloads + ECHO And make sure its in the path + GOTO :end +) -IF %ERRORLEVEL% ==A GOTO ALL -::IF ERRORLEVEL ==1 -::IF ERRORLEVEL ==2 -::IF ERRORLEVEL ==3 -::IF ERRORLEVEL ==4 -::IF ERRORLEVEL ==5 -::IF ERRORLEVEL ==6 -::IF ERRORLEVEL ==7 +where /q node +IF ERRORLEVEL 1 ( + ECHO Error: node is not installed. + ECHO Please Install NodeJS from: https://nodejs.org/en/download/ + ECHO And make sure its in the path + GOTO :end +) -:ALL -cd .. -mkdir discord-open-source-repos -cd discord-open-source-repos -git clone https://github.com/discord-open-source/discord-dashboard.git -git clone https://github.com/discord-open-source/discord-api.git -git clone https://github.com/discord-open-source/discord-gateway.git -git clone https://github.com/discord-open-source/discord-cdn.git -git clone https://github.com/discord-open-source/discord-client.git -git clone https://github.com/discord-open-source/discord-react-native.git -git clone https://github.com/discord-open-source/discord-react.git -git clone https://github.com/discord-open-source/discord-css.git +where /q npm +IF ERRORLEVEL 1 ( + ECHO 'Error: npm is not installed.' >&2 + ECHO Please install npm from: https://nodejs.org/en/download/ + ECHO And make sure its in the path + GOTO :end +) +echo Dependencies are already Installed +ECHO. +echo Creating organization directory +ECHO. +CD ..\..\ +MKDIR discord-open-source-workspace +cd discord-open-source-workspace +ECHO Cloning all repositories +ECHO. +git clone https://github.com/discord-open-source/discord-api api +git clone https://github.com/discord-open-source/discord-gateway gateway +git clone https://github.com/discord-open-source/discord-voice voice +git clone https://github.com/discord-open-source/discord-cdn cdn +git clone https://github.com/discord-open-source/discord-css design +git clone https://github.com/discord-open-source/discord-client client +git clone https://github.com/discord-open-source/discord-react react +git clone https://github.com/discord-open-source/discord-react-native react-native +git clone https://github.com/discord-open-source/discord-dashboard dashboard + +where /q code +IF ERRORLEVEL 0 ( + echo {"folders":[{"path":"cdn"},{"path":"api"},{"path":"gateway"},{"path":"voice"},{"path":"design"},{"path":"react"},{"path":"client"},{"path":"react-native"},{"path":"dashboard"}]}> discord-open-source.code-workspace + + ECHO Opening VSCode Workspace + code discord-open-source.code-workspace +) + +:end +@ECHO on +PAUSE diff --git a/setup/setup.sh b/setup/setup.sh index 2913880..ab0c4b6 100755 --- a/setup/setup.sh +++ b/setup/setup.sh @@ -15,13 +15,13 @@ fi echo --------------------- echo Checking dependencies if ! [ -x "$(command -v git)" ]; then - echo 'Error: git is not installed.' >&2 + echo Error: git is not installed. echo Please Install git from: https://git-scm.com/downloads echo And make sure its in the path exit 1 fi if ! [ -x "$(command -v node)" ]; then - echo 'Error: node is not installed.' >&2 + echo Error: node is not installed. echo Please Install NodeJS from: https://nodejs.org/en/download/ echo And make sure its in the path exit 1 @@ -32,7 +32,7 @@ if ! [ -x "$(command -v npm)" ]; then echo And make sure its in the path exit 1 fi -echo ✓ All Dependencies Installed +echo ✓ Dependencies are already Installed echo ------------------------------- echo Creating organization directory cd ../../ @@ -41,6 +41,7 @@ mkdir discord-open-source mv overview discord-open-source/ cd discord-open-source echo Cloning all repositories + git clone https://github.com/discord-open-source/discord-api api git clone https://github.com/discord-open-source/discord-gateway gateway git clone https://github.com/discord-open-source/discord-voice voice @@ -50,6 +51,7 @@ git clone https://github.com/discord-open-source/discord-client client git clone https://github.com/discord-open-source/discord-react react git clone https://github.com/discord-open-source/discord-react-native react-native git clone https://github.com/discord-open-source/discord-dashboard dashboard + if [ -x "$(command -v code)" ]; then echo '{"folders":[{"path":"overview"},{"path":"cdn"},{"path":"api"},{"path":"gateway"},{"path":"voice"},{"path":"design"},{"path":"react"},{"path":"client"},{"path":"react-native"},{"path":"dashboard"}]}' >> discord-open-source.code-workspace echo Open VSCode Workspace From 7420f8542ef5374cfcec63d92ef79067ddd6c754 Mon Sep 17 00:00:00 2001 From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> Date: Thu, 4 Feb 2021 17:08:35 +0100 Subject: [PATCH 07/12] Update README | remove >>> chars for easier copy --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d098baf..f18243a 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,9 @@ if we are finished we'll host our own instance. ## Get started ```bash ->>> git clone https://github.com/discord-open-source/discord-open-source.git discord-open-source ->>> cd discord-open-source/setup ->>> setup +git clone https://github.com/discord-open-source/discord-open-source.git discord-open-source +cd discord-open-source/setup +setup ``` ## Contribute From d3549f6eb17e8683e54e92d4a86a532d4aafbbd5 Mon Sep 17 00:00:00 2001 From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> Date: Thu, 4 Feb 2021 20:34:34 +0100 Subject: [PATCH 08/12] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f18243a..e2ce90d 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ | [CSS](https://github.com/discord-open-source/discord-css) | Unofficial css framework in the style of Discord. | | [API](https://github.com/discord-open-source/discord-API) | Discord API server for discord-client | | [Gateway](https://github.com/discord-open-source/discord-gateway) | Discord Gateway for discord-client | +| [Server-Util](https://github.com/discord-open-source/discord-server-util) | Utility functions for the all server repositories | [Dashboard](https://github.com/discord-open-source/discord-dashboard) | An admin dashboard for discord-server | | [Client](https://github.com/discord-open-source/discord-client) | Discord Client for discord-server | | [CDN](https://github.com/discord-open-source/discord-cdn) | [Content-delivery-network](https://www.cloudflare.com/learning/cdn/what-is-a-cdn/) for the server, used to store images and assets | From 06d7cdb0435af6245dc677d8631ab2ae296d24d8 Mon Sep 17 00:00:00 2001 From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> Date: Thu, 4 Feb 2021 20:35:37 +0100 Subject: [PATCH 09/12] Update setup.sh --- setup/setup.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/setup/setup.sh b/setup/setup.sh index ab0c4b6..1ddf501 100755 --- a/setup/setup.sh +++ b/setup/setup.sh @@ -43,6 +43,7 @@ cd discord-open-source echo Cloning all repositories git clone https://github.com/discord-open-source/discord-api api +git clone https://github.com/discord-open-source/discord-server-util server-util git clone https://github.com/discord-open-source/discord-gateway gateway git clone https://github.com/discord-open-source/discord-voice voice git clone https://github.com/discord-open-source/discord-cdn cdn @@ -53,7 +54,7 @@ git clone https://github.com/discord-open-source/discord-react-native react-nati git clone https://github.com/discord-open-source/discord-dashboard dashboard if [ -x "$(command -v code)" ]; then - echo '{"folders":[{"path":"overview"},{"path":"cdn"},{"path":"api"},{"path":"gateway"},{"path":"voice"},{"path":"design"},{"path":"react"},{"path":"client"},{"path":"react-native"},{"path":"dashboard"}]}' >> discord-open-source.code-workspace + echo '{"folders":[{"path":"overview"},{"path":"cdn"},{"path":"api"},{"path":"gateway"},{"path":"voice"},{"path":"server-util"},{"path":"design"},{"path":"react"},{"path":"client"},{"path":"react-native"},{"path":"dashboard"}]}' >> discord-open-source.code-workspace echo Open VSCode Workspace code discord-open-source.code-workspace fi From ec64e2bbd170c8f58768da64cd1f1e8c3c9cf450 Mon Sep 17 00:00:00 2001 From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> Date: Thu, 4 Feb 2021 20:36:09 +0100 Subject: [PATCH 10/12] Update setup.bat --- setup/setup.bat | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/setup/setup.bat b/setup/setup.bat index 969d948..740b131 100644 --- a/setup/setup.bat +++ b/setup/setup.bat @@ -47,6 +47,7 @@ ECHO. git clone https://github.com/discord-open-source/discord-api api git clone https://github.com/discord-open-source/discord-gateway gateway git clone https://github.com/discord-open-source/discord-voice voice +git clone https://github.com/discord-open-source/discord-server-util server-util git clone https://github.com/discord-open-source/discord-cdn cdn git clone https://github.com/discord-open-source/discord-css design git clone https://github.com/discord-open-source/discord-client client @@ -56,7 +57,7 @@ git clone https://github.com/discord-open-source/discord-dashboard dashboard where /q code IF ERRORLEVEL 0 ( - echo {"folders":[{"path":"cdn"},{"path":"api"},{"path":"gateway"},{"path":"voice"},{"path":"design"},{"path":"react"},{"path":"client"},{"path":"react-native"},{"path":"dashboard"}]}> discord-open-source.code-workspace + echo {"folders":[{"path":"cdn"},{"path":"api"},{"path":"gateway"},{"path":"voice"},{"path":"server-util"},{"path":"design"},{"path":"react"},{"path":"client"},{"path":"react-native"},{"path":"dashboard"}]}> discord-open-source.code-workspace ECHO Opening VSCode Workspace code discord-open-source.code-workspace From 360307f6774d08fb67e9533981acdbe9dd6d8353 Mon Sep 17 00:00:00 2001 From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> Date: Sat, 6 Feb 2021 14:56:38 +0100 Subject: [PATCH 11/12] Update README.md --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e2ce90d..b6414f2 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,19 @@ ## Motivation Discord Open Source aims to be a full one-on-one clone of Discord, adding more features that can be used as a replacement for the official client and still connect and host private Discord server instances. + Discord Open Source aims to give the best possible user experience, while combining Discord's UI, features and adding new ones/improving old ones. +The client can connect to multiple server instances without the need to open it multiple times. + +The client should be extensible through a secure Plugin and Theme System with own store. + +The server should be extensible through bots, just like discord without the need to change anything except the api endpoint. + +The project is open source so everyone can have a look what's going on under the hood and can be maintained and expanded by the community. + +Everything is configurable in the server config and everyone can add their own features, so that it is not opinionated. + ## Support https://discord.gg/ZrnGQP6p3d if we are finished we'll host our own instance. @@ -32,4 +43,6 @@ setup ``` ## Contribute -First of all, [read this issue](https://github.com/discord-open-source/discord-open-source/issues/10) +This project is only possible by volunteers like you and me, your contribution is very much appreciated 🥺. + +If you want to make this project reality and and you would like to contribute then [read this issue](https://github.com/discord-open-source/discord-open-source/issues/10) first. From 489c12a55395415b395c68c574968d7e4d0bee69 Mon Sep 17 00:00:00 2001 From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com> Date: Sat, 6 Feb 2021 19:46:16 +0100 Subject: [PATCH 12/12] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b6414f2..a3c16fd 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ | Repo name | Brief description | | :-------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- | -| [CSS](https://github.com/discord-open-source/discord-css) | Unofficial css framework in the style of Discord. | -| [API](https://github.com/discord-open-source/discord-API) | Discord API server for discord-client | -| [Gateway](https://github.com/discord-open-source/discord-gateway) | Discord Gateway for discord-client | +| [CSS](https://github.com/discord-open-source/discord-css) | Open Source CSS framework in the style of Discord. | +| [API](https://github.com/discord-open-source/discord-API) | Discord HTTP API Server for discord-client | +| [Gateway](https://github.com/discord-open-source/discord-gateway) | Discord WebSocket Gateway Server for discord-client | | [Server-Util](https://github.com/discord-open-source/discord-server-util) | Utility functions for the all server repositories -| [Dashboard](https://github.com/discord-open-source/discord-dashboard) | An admin dashboard for discord-server | -| [Client](https://github.com/discord-open-source/discord-client) | Discord Client for discord-server | +| [Dashboard](https://github.com/discord-open-source/discord-dashboard) | An admin dashboard for discord-server (analytics, settings) | +| [Client](https://github.com/discord-open-source/discord-client) | Open Source Discord Client compatible with discord-server and discord.com | | [CDN](https://github.com/discord-open-source/discord-cdn) | [Content-delivery-network](https://www.cloudflare.com/learning/cdn/what-is-a-cdn/) for the server, used to store images and assets | | [React](https://github.com/discord-open-source/discord-react) | All discord-css components for React | | [React-Native](https://github.com/discord-open-source/discord-react-native) | All discord-css components for React-Native |