1
0
mirror of https://github.com/spacebarchat/server.git synced 2024-11-11 05:02:37 +01:00
server/README.md

41 lines
1.1 KiB
Markdown
Raw Normal View History

2021-02-09 09:51:19 +01:00
# Fosscord API Server
2021-02-03 19:06:11 +01:00
This repository contains the HTTP API Server
2021-02-03 11:52:49 +01:00
## Bug Tracker
2021-02-09 09:51:19 +01:00
[Project Board](https://github.com/fosscord/fosscord-server/projects/4)
2021-02-03 11:52:49 +01:00
## API
2021-02-09 09:51:19 +01:00
[Project Board](https://github.com/fosscord/fosscord-server/projects/2)
2021-02-03 11:52:49 +01:00
We use [express](https://expressjs.com/) for the HTTP Server and
[lambert-server](https://www.npmjs.com/package/lambert-server) for route handling and body validation (customized).
## Contribution
You should be familiar with:
- [Git](https://git-scm.com/)
- [NodeJS](https://nodejs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [Lambert-DB](https://www.npmjs.com/package/lambert-db) (easy database abstraction wrapper)
2021-02-03 19:06:11 +01:00
and the other technologies we use
2021-02-03 11:52:49 +01:00
### Getting Started
Clone the Repository:
```bash
2021-02-09 09:51:19 +01:00
git clone https://github.com/fosscord/fosscord-server
2021-02-03 11:52:49 +01:00
cd discord-server
```
#### Install (dev)dependencies:
```bash
npm install
npm install --only=dev
```
#### Starting:
```
npm start
```
#### Debugging:
**Vscode:**
The Launch file configuration is in ``./vscode/launch.json``,
so you can just debug the server by pressing ``F5`` or the ``> Launch Server`` button