2021-07-21 14:34:30 +01:00
|
|
|
> Welcome to the main README.
|
|
|
|
|
|
2021-07-21 14:50:53 +01:00
|
|
|
**This repo consists of 3 projects.**
|
2021-07-21 14:34:30 +01:00
|
|
|
|
2021-07-31 17:08:33 +01:00
|
|
|
## Branches
|
|
|
|
|
|
2021-07-31 17:20:55 +01:00
|
|
|
- `ap` - Alpha prototype
|
|
|
|
|
- `bp` - Beta prototype
|
|
|
|
|
- `p` - Final prototype
|
|
|
|
|
- `v1` - Version number
|
2021-07-31 17:08:33 +01:00
|
|
|
|
|
|
|
|
### DClone Essential
|
|
|
|
|
|
|
|
|
|
> v1 - v6
|
|
|
|
|
|
|
|
|
|
- The core features of Discord.
|
|
|
|
|
|
|
|
|
|
### DClone Full
|
|
|
|
|
|
|
|
|
|
> v6 - v12
|
|
|
|
|
|
|
|
|
|
- In development.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2021-07-21 14:34:30 +01:00
|
|
|
## API
|
|
|
|
|
|
|
|
|
|
- The backend of the website.
|
|
|
|
|
- Includes the WebSocket and REST API.
|
|
|
|
|
|
2021-07-31 17:21:41 +01:00
|
|
|
## Types
|
2021-07-21 14:34:30 +01:00
|
|
|
|
2021-07-31 17:21:41 +01:00
|
|
|
- Ambient types for both project intellisense.
|
2021-07-21 14:34:30 +01:00
|
|
|
|
|
|
|
|
## Website
|
|
|
|
|
|
|
|
|
|
- The UI.
|
|
|
|
|
- Cool but useless without the API running in the background.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Setup
|
|
|
|
|
|
2021-07-24 21:28:00 +01:00
|
|
|
`api/.env`
|
2021-07-21 14:34:30 +01:00
|
|
|
|
|
|
|
|
```
|
2021-07-21 14:54:40 +01:00
|
|
|
API_PORT=3000
|
|
|
|
|
API_PREFIX="/api/v1"
|
2021-07-29 14:12:00 +01:00
|
|
|
JWT_SECRET_KEY="something secret"
|
2021-07-29 11:55:01 +01:00
|
|
|
MONGO_URI="mongodb://localhost/dclone-essential"
|
2021-07-21 14:54:40 +01:00
|
|
|
WEBSITE_PORT=4200
|
2021-07-21 14:34:30 +01:00
|
|
|
```
|
