Proyecto-Titulo
/
alai-server
3
0
Fork 0
Code Issues Pull Requests Releases Activity

add configuration and move license

This commit is contained in:
Chris Cromer 2022-07-22 23:20:43 -04:00
parent 87269e3b70
commit e7ce26a28b
Signed by: cromer
GPG Key ID: FA91071797BEEEC2
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -7,6 +7,9 @@ This is the server which will host the Alai game binaries, backend API that rece
- Christohper Cromer
- Martín Araneda Acuña
## License
The server is licensed under the [3-Clause BSD License](LICENSE).
## Backend API
The backend is written in *go* and uses gorm to handle its database schema.
@ -15,6 +18,10 @@ The backend is written in *go* and uses gorm to handle its database schema.
The directory game should contain the binaries for Alai which will be exposed through nginx for downloading.
## Configure
Before the server can be built and run, a *.env* file should be created based on *.env.example*. If the server is going to be public facing, make sure to change all the secrets and passwords to make it more secure.
## Build and run
```
@ -25,7 +32,4 @@ docker-compose up -d --build
```
docker-compose down
```
## License
The server is licensed under the [3-Clause BSD License](LICENSE).
```