3

Contributing

Flam3rboy edited this page 2021-05-15 11:58:38 +02:00

Table of Contents

• Requirements
• Getting Started
• Install (dev)dependencies:
• Starting:
• Debugging:

Requirements

You should be familiar with:

• Git
• NodeJS
• TypeScript
• Mongoose

and the technologies we use for the API.

Getting Started

Clone the Repository:

git clone https://github.com/fosscord/fosscord-api
cd fosscord-api

Install (dev)dependencies:

npm install

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

1. Home

2. Contributing

3. Project Structure

4. Config

5. Database

6. Permission

7. Testing

8. Route