Spacebar/docs
1
0
Fork 0
mirror of https://github.com/spacebarchat/docs.git synced 2024-11-22 10:12:31 +01:00
Code Issues Releases Activity

Don't hire me to write technical documentation.

Browse Source
This commit is contained in:
Madeline 2022-12-31 19:17:32 +11:00
parent 9f5e853d04
commit de41ac6b84
No known key found for this signature in database
GPG Key ID: 1958E017C36F2E47
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/contributing/index.md
View File

@ -2,6 +2,12 @@
!!! info "[Have you read the Code of Conduct?](conduct.md)"
## Notable Technologies
* Typescript
* [Typeorm](https://www.npmjs.com/package/typeorm)
* [WS](https://www.npmjs.com/package/ws)
* [Express](https://www.npmjs.com/package/express)
## Structure
Fosscord is written in Typescript and is comprised of 4 main parts:
@ -10,3 +16,15 @@ Fosscord is written in Typescript and is comprised of 4 main parts:
- Websocket Gateway server for realtime communication with clients
- HTTP CDN server for storing user file content.
- `utils` module to separate our database models, schemas, and other things from the above 3 components.
### Gateway
The Gateway is a WebSocket server that is responsible for listening and emitting events to/from connected clients.
### API
The API is a HTTP REST server which does the bulk of the database reads/writes.
## Documentation
Unfortunately writing documentation is quite annoying. There's tons of comments in the codebase tho, so don't worry :)