1
0
mirror of https://github.com/spacebarchat/spacebarchat.git synced 2024-11-25 20:02:55 +01:00
spacebarchat/api/project-structure.md
2021-05-04 14:10:30 +00:00

1002 B

Project-Structure

This repository currently contains the HTTP API Server

Translation

Additionally we use i18next to manage translation/localization in some API Responses.

The .json language files are located in /locales and are separated by namespaces.

Source code

We use TypeScript JavaScript with types. The .ts source files are located in /src/ and will be compiled to .js in the /dist/ directory.

Middlewares

All Express Middlewares are in the directory /src/middlewares/ and need to be manually loaded in /src/Server.ts.

Routes

All Express Router Routes are in the directory /src/routes/ and are automatically registered.

Models

All Database Typescript interface models are in the directory /src/models/

Util

All Utility functions are in the directory /src/util/.