Init commit.
Add: simple project structure for `mygo.server`. Add: README files.
This commit is contained in:
32
mygo.server/README.md
Normal file
32
mygo.server/README.md
Normal file
@ -0,0 +1,32 @@
|
||||
# MyGO Server
|
||||
|
||||
This is the server backend of MyGO.
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] CLI
|
||||
- [ ] Web (JWT) Authentication
|
||||
- [ ] User Administration APIs
|
||||
- [ ] File upload and download (HTTP)
|
||||
|
||||
## Usage
|
||||
|
||||
To run the server simply:
|
||||
|
||||
```bash
|
||||
mygo web
|
||||
```
|
||||
|
||||
To run the server with specified configuration file (default: `./config.yml`):
|
||||
|
||||
```bash
|
||||
mygo web -c /path/to/config.yml
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
### mygo web
|
||||
|
||||
Run the HTTP web server and listen on the specified port.
|
||||
|
||||
|
Reference in New Issue
Block a user