From f9fff9e224e1f7ec9126baf49efacce917d3a88b Mon Sep 17 00:00:00 2001 From: "Navy.gif" Date: Sun, 30 Apr 2023 02:50:22 +0300 Subject: [PATCH] update readme --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 5b4b4ea..d9335d2 100644 --- a/README.md +++ b/README.md @@ -38,17 +38,17 @@ Linux: `ln -s /path/to/frontend/build /path/to/backend/files/build` Windows (admin cmd) `mklink /D C:\Path\To\Backend\files\build C:\Path\To\Frontend\build` ## Src directory structure -- controller: Main controller, takes care of sharding and the shard life-cycles. Also instantiates the master process - - commands: Commands you can issue to the controller -- server: Code running on the shards, most of the functionality lives here - - components: Base components the server uses - - database: Various database extensions, database interactions are primarily handled by [these wrappers](https://git.corgi.wtf/Navy.gif/wrappers) - - endpoints: Endpoint functionality, can be organised into subfolders, or not - - interfaces: Various interfaces and parent classes - - middleware: Middleware functions and classes for express - - structures: Abstractions for various API entities, e.g. user & role -- util: Shared utility functionality & misc stuff - - errors: Error classes +/controller: Main controller, takes care of sharding and the shard life-cycles. Also instantiates the master process + /commands: Commands you can issue to the controller +/server: Code running on the shards, most of the functionality lives here + /components: Base components the server uses + /database: Various database extensions, database interactions are primarily handled by [these wrappers](https://git.corgi.wtf/Navy.gif/wrappers) + /endpoints: Endpoint functionality, can be organised into subfolders, or not + /interfaces: Various interfaces and parent classes + /middleware: Middleware functions and classes for express + /structures: Abstractions for various API entities, e.g. user & role +/util: Shared utility functionality & misc stuff + /errors: Error classes ## TODO - Dependency injection for structures, such as User.