pvtchat/README.md

96 lines
2.4 KiB
Markdown
Raw Normal View History

2022-12-16 23:19:48 +00:00
# Accord - Messaging Made Simple.
2021-08-03 17:06:01 +01:00
2021-11-12 14:40:18 +00:00
> Built with React, Redux, and Node.js.
2021-08-25 13:31:48 +01:00
2021-11-12 14:40:18 +00:00
Accord is an app, similar to Discord, but cooler.
**Please star this repo to support development.**
2021-08-03 17:06:01 +01:00
2021-08-31 23:37:19 +01:00
<a href="https://ibb.co/kgndDwd"><img src="https://i.ibb.co/N6h4NJ4/Screenshot-from-2021-08-31-16-09-41.png" alt="Screenshot-from-2021-08-31-16-09-41" border="0" /></a>
2021-08-30 13:29:10 +01:00
<a href="https://ibb.co/st2q2B0"><img src="https://i.ibb.co/fQ2H2ch/Screenshot-from-2021-08-30-11-55-01.png" alt="Screenshot-from-2021-08-30-11-55-01" border="0" /></a>
2021-08-30 13:43:49 +01:00
<a href="https://ibb.co/SydPgTY"><img src="https://i.ibb.co/qjWd8Gq/Screenshot-from-2021-08-30-13-30-43.png" alt="Screenshot-from-2021-08-30-13-30-43" border="0" /></a>
2021-08-03 17:06:01 +01:00
2021-12-18 23:09:46 +00:00
> Want more stable commits? [Use the stable branch](/tree/v2-stable).
2021-11-11 16:07:41 +00:00
2021-10-09 20:05:19 +01:00
---
## Setup
1. Clone the repo.
2. Generate SSH keys.
2021-10-24 16:54:25 +01:00
From app folder:
```
mkdir -p backend/keys
2021-11-02 19:58:26 +00:00
ssh-keygen -t rsa -b 2048 -m PEM -f backend/keys/jwt
2021-10-24 16:54:25 +01:00
```
2021-10-09 20:05:19 +01:00
3. Install npm packages.
2021-11-02 19:58:26 +00:00
From app folder:
```
cd frontend
npm i
cd ../backend
npm i
```
4. Configure `backend/.env.example` and rename it to `.env`
2021-10-09 20:05:19 +01:00
---
2021-08-03 17:06:01 +01:00
## Features
- **Server Channels**
- Create channels
- Delete channels
- **Message Management**
- Server owners can delete any message
- Message author can delete and edit their own messages
- **Member Management**
- Kick members as the server owner
- Easily leave the server by right clicking the server
- Join servers with an invite code
- **Server Management**
- Create servers as you would in Discord
- Edit server name, and icon URL in the server settings
- Delete your server in the server settings
- **User Management**
- Manage your account by clicking the settings icon
- Change your username, and avatar
- Delete your user and prevent it from being used to login
- **and more** (of course)
2021-08-30 13:44:15 +01:00
> Want a more basic version, that's more like Discord?
> https://github.com/codea-live/dclone
2021-11-30 02:28:25 +00:00
---
`backend/.env`
(dev with Docker)
```
EMAIL_ADDRESS="...@gmail.com"
EMAIL_PASSWORD="..."
MONGO_URI="mongodb://database/accord"
NODE_ENV="dev"
PORT=3000
WEBSITE_URL="http://localhost:4200"
```
`backend/test/.env`
(test without Docker)
```
API_URL="http://localhost:3001/api"
EMAIL_ADDRESS="...@gmail.com"
EMAIL_PASSWORD="..."
MONGO_URI="mongodb://localhost/accord-test"
NODE_ENV="dev"
PORT=3001
ROOT_ENDPOINT="http://localhost:3001"
WEBSITE_URL="http://localhost:4200"
```
2021-12-18 23:09:46 +00:00
---
2022-12-16 23:19:48 +00:00
### Worth checking out...
2021-12-18 23:09:46 +00:00
2022-12-16 23:19:48 +00:00
- Check out [fosscord](https://github.com/fosscord/fosscord).