add configuration and move license
This commit is contained in:
parent
87269e3b70
commit
e7ce26a28b
12
README.md
12
README.md
@ -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).
|
||||
```
|
Loading…
Reference in New Issue
Block a user