update readme
This commit is contained in:
parent
8c20617144
commit
9a238039ae
13
README.md
13
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
|
||||
|
Loading…
Reference in New Issue
Block a user