This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
backend/README.md

40 lines
927 B
Markdown
Raw Normal View History

2021-06-06 16:33:34 +00:00
# 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)