1
0
mirror of https://github.com/spacebarchat/spacebarchat.git synced 2024-11-25 11:52:56 +01:00
This commit is contained in:
TimSchweiz 2021-02-07 07:53:53 +01:00
commit b548f7c009
4 changed files with 158 additions and 35 deletions

View File

@ -4,10 +4,12 @@
| Repo name | Brief description | | Repo name | Brief description |
| :-------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- | | :-------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- |
| [CSS](https://github.com/discord-open-source/discord-css) | Unofficial css framework in the style of Discord. | | [CSS](https://github.com/discord-open-source/discord-css) | Open Source 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 HTTP API Server for discord-client |
| [Dashboard](https://github.com/discord-open-source/discord-dashboard) | An admin dashboard for discord-server | | [Gateway](https://github.com/discord-open-source/discord-gateway) | Discord WebSocket Gateway Server for discord-client |
| [Client](https://github.com/discord-open-source/discord-client) | Discord Client for discord-server | | [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 (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 | | [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](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 | | [React-Native](https://github.com/discord-open-source/discord-react-native) | All discord-css components for React-Native |
@ -15,15 +17,32 @@
## Motivation ## 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 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. 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.
## Get started ## Get started
```bash ```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 cd discord-open-source/setup
>>> setup setup
``` ```
## Contribute ## Contribute
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.

14
setup/README.md Normal file
View File

@ -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
```

View File

@ -4,35 +4,65 @@ ECHO Discord-Open-Source-Installer
ECHO v0.1 ~xnacly ECHO v0.1 ~xnacly
ECHO. ECHO.
ECHO str+c/str+d to exit ECHO str+c/str+d to exit
ECHO 1: /discord-dashboard.git
ECHO 2: /discord-server.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 A: all of the above
ECHO. 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 where /q node
::IF ERRORLEVEL ==1 IF ERRORLEVEL 1 (
::IF ERRORLEVEL ==2 ECHO Error: node is not installed.
::IF ERRORLEVEL ==3 ECHO Please Install NodeJS from: https://nodejs.org/en/download/
::IF ERRORLEVEL ==4 ECHO And make sure its in the path
::IF ERRORLEVEL ==5 GOTO :end
::IF ERRORLEVEL ==6 )
::IF ERRORLEVEL ==7
:ALL where /q npm
cd .. IF ERRORLEVEL 1 (
mkdir discord-open-source-repos ECHO 'Error: npm is not installed.' >&2
cd discord-open-source-repos ECHO Please install npm from: https://nodejs.org/en/download/
git clone https://github.com/discord-open-source/discord-dashboard.git ECHO And make sure its in the path
git clone https://github.com/discord-open-source/discord-server.git GOTO :end
git clone https://github.com/discord-open-source/discord-cdn.git )
git clone https://github.com/discord-open-source/discord-client.git echo Dependencies are already Installed
git clone https://github.com/discord-open-source/discord-react-native.git ECHO.
git clone https://github.com/discord-open-source/discord-react.git echo Creating organization directory
git clone https://github.com/discord-open-source/discord-css.git 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-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
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":"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
)
:end
@ECHO on
PAUSE

60
setup/setup.sh Executable file
View File

@ -0,0 +1,60 @@
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.
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.
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 ✓ Dependencies are already 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-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
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":"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