Commit 72ed721e authored by Vít Kološ's avatar Vít Kološ
Browse files

Merged PR 3925: feature: new license, readme modified

feature: new license, readme modified
parent 4f46a3f3
MIT License
Copyright (c) 2022 Ministry of Health of the Czech Republic
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.
......@@ -2,64 +2,33 @@
## Links
- 🖥 **production version** - [https://covid.gov.cz/](https://covid.gov.cz/)
- 🛠 "staging" version - [https://covidportal.dev/](https://covidportal.dev/) (hosted on Vercel)
- [Trello](https://trello.com/b/XOOBy51q/covidgovcz)
- 🖥 **production version**: [covid.gov.cz](https://covid.gov.cz/)
## Contribute
## Getting started
- join 🇨🇿 **cesko.digital** through - [https://join.cesko.digital/](https://join.cesko.digital/)
1. after receiving slack link, join us in the respective channel:
`#p-informacni-web-ceska`
`#p-informacni-web-frontend`
`#p-informacni-web-drupal`
2. introduce yourself + just fork this project or just ask for GitHub privileges in our Slack
3. choose your starter task from our [Trello](https://trello.com/b/XOOBy51q/covidgovcz)
4. create a branch and PR for the task
*we usually tend to use a descriptive PR title e.g.:* `gatsby/feat: task title` *or* `drupal/fix: task title`, *i guess you get the point*
6. after PR creation:
- we will receive a notification in our slack channel to do the review
- your branch will be deployed to a feature branch on Vercel (comment by Vercel bot)
- check your changes in the prod build on Vercel
7. after the review and approval ✅, we will merge the PR and it will be eventually deployed to production
## Getting started
### Frontend - Gatsby
### Frontend (Gatsby)
If you only want to run frontend part of this app, you **dont have to install Docker** and the backend part. It works standalone as well - see the frontend for more details
- 🚀 [see how to get up and running with the frontend](/gatsby/README.md#gatsby) ➡️
- 🚀 [see how to get up and running with the frontend](/gatsby/README.md#gatsby) ➡️
### Backend - Drupal
### Backend (Drupal)
We're using docker containers from `docker` folder:
- `cd docker`
- `cd docker`
Copy and modify env file as needed
- `cp .env.example .env`
- `cp .env.example .env`
Start containers
- `docker-compose up -d`
- `docker-compose up -d`
Install dependencies
- `docker-compose exec drupal composer install`
- `docker-compose exec drupal composer install`
Install Drupal with existing config, database connection is already injected in settings.php file
......@@ -67,4 +36,4 @@ Install Drupal with existing config, database connection is already injected in
Access site on `http://localhost:1577` if you didn't change
`COVID_PORT_NGINX` variable in your `env` file
\ No newline at end of file
`COVID_PORT_NGINX` variable in your `env` file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment