From 08e837bf5559e9680fc8cb99bd05b93f8eb2cac5 Mon Sep 17 00:00:00 2001
From: Flam3rboy <34555296+Flam3rboy@users.noreply.github.com>
Date: Thu, 12 Aug 2021 20:09:35 +0200
Subject: :sparkles: api

---
 api/README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 api/README.md

(limited to 'api/README.md')

diff --git a/api/README.md b/api/README.md
new file mode 100644
index 00000000..c8a33a0b
--- /dev/null
+++ b/api/README.md
@@ -0,0 +1,67 @@
+<p align="center">
+  <img width="100" src="https://raw.githubusercontent.com/fosscord/fosscord/master/assets/logo_big_transparent.png" />
+</p>
+<h1 align="center">Fosscord HTTP API Server</h1>
+
+<p>
+  <a href="https://discord.gg/ZrnGQP6p3d">
+    <img src="https://img.shields.io/discord/806142446094385153?color=7489d5&logo=discord&logoColor=ffffff" />
+  </a>
+  <img src="https://img.shields.io/static/v1?label=Status&message=Development&color=blue">
+  <a title="Crowdin" target="_blank" href="https://translate.fosscord.com/"><img src="https://badges.crowdin.net/fosscord/localized.svg"></a>
+   <a href="https://opencollective.com/fosscord">
+    <img src="https://opencollective.com/fosscord/tiers/badge.svg">
+  </a>
+</p>
+
+## [About](https://github.com/fosscord/fosscord-api/wiki)
+
+This repository contains the Fosscord HTTP API Server
+
+## Bug Tracker
+
+[Project Board](https://fosscord.notion.site/2c7fe9e73f9842d3bab3a4912dedd091)
+
+## API
+
+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/)
+-   [MongoDB/mongoose](http://mongoosejs.com/)
+
+and the other technologies we use
+
+### Getting Started
+
+Clone the Repository:
+
+```bash
+git clone https://github.com/fosscord/fosscord-api
+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
-- 
cgit 1.5.1