Navy.gif/webserver-framework
Template
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Erik 2023-04-30 02:49:25 +03:00
parent 8c20617144
commit 9a238039ae
Signed by: Navy.gif
GPG Key ID: 2532FBBB61C65A68
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -37,6 +37,19 @@ E.g.
Linux: `ln -s /path/to/frontend/build /path/to/backend/files/build` 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` 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 ## TODO
- Dependency injection for structures, such as User. - Dependency injection for structures, such as User.
- Some kind of plugin system - Some kind of plugin system