zdam-egzamin-zawodowy
/
backend
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: add README.md and LICENSE

This commit is contained in:
Dawid Wysokiński 2021-06-06 18:33:34 +02:00
parent 211e44838f
commit 294584e8b8
2 changed files with 60 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2021 Dawid Wysokiński
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

39
README.md Normal file
View File

@ -0,0 +1,39 @@
# zdamegzaminzawodowy.pl - backend
This project contains the API and other core infrastructure items needed for all [zdamegzaminzawodowy.pl](https://zdamegzaminzawodowy.pl) apps.
## Development
### Prerequisites
1. Golang
2. PostgreSQL database
### Installation
**Required ENV variables (you can set them directly in your system or create the .env.local file):**
```
DB_USER=db_user
DB_NAME=db_name
DB_PORT=db_port
DB_HOST=db_host
DB_PASSWORD=db_pass
DB_POOL_SIZE=40
LOG_DB_QUERIES=true
ACCESS_SECRET=access_token_secret
FILE_STORAGE_PATH=path_to_the_folder_where_uploaded_files_will_be_stored
```
1. Clone this repo.
```
git@github.com:zdam-egzamin-zawodowy/backend.git
```
2. Set the required env variables.
3. Run the app.
```
go run main.go
```
## License
Distributed under the MIT License. See ``LICENSE`` for more information.
## Contact
Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)