diff --git a/README.md b/README.md index 16cafa2..5b4b4ea 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,19 @@ E.g. 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 + ## TODO - Dependency injection for structures, such as User. - Some kind of plugin system