8

Project Structure

Flam3rboy edited this page 2021-02-04 09:57:09 +01:00

Table of Contents

• Translation
• Source code
• Middlewares
• Routes
• Models
• Util

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/.

1. Home

2. Contributing

3. Project Structure

4. Config

5. Database

6. Permission

7. Testing

8. Route