From 294584e8b8386e654eb38c85ff2afe96bf4b50b9 Mon Sep 17 00:00:00 2001 From: Kichiyaki Date: Sun, 6 Jun 2021 18:33:34 +0200 Subject: [PATCH] feat: add README.md and LICENSE --- LICENSE | 21 +++++++++++++++++++++ README.md | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0031977 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..11942a7 --- /dev/null +++ b/README.md @@ -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)