mirror of
https://github.com/spacebarchat/spacebarchat.git
synced 2026-10-22 19:42:24 +00:00
38 lines
651 B
Markdown
38 lines
651 B
Markdown
# Contributing
|
|
|
|
You should be familiar with:
|
|
|
|
* [Git](https://git-scm.com/)
|
|
* [NodeJS](https://nodejs.org/)
|
|
* [TypeScript](https://www.typescriptlang.org/)
|
|
* [Mongoose](https://mongoosejs.com/)
|
|
|
|
and the technologies we use for the API.
|
|
|
|
## Getting Started
|
|
|
|
Clone the Repository:
|
|
|
|
```bash
|
|
git clone https://github.com/fosscord/fosscord-api
|
|
cd fosscord-api
|
|
```
|
|
|
|
### Install \(dev\)dependencies:
|
|
|
|
```bash
|
|
npm install
|
|
npm install --only=dev
|
|
```
|
|
|
|
### Starting:
|
|
|
|
```text
|
|
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
|
|
|