- add licence and readme.md files

This commit is contained in:
Arno Kaimbacher 2020-11-12 16:48:24 +01:00
parent 731ebe85b5
commit a8f58d0860
2 changed files with 51 additions and 0 deletions

22
LICENSE Normal file
View File

@ -0,0 +1,22 @@
MIT License
-----------
Copyright (c) 2020, Geologische Bundesanstalt (GBA)
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.

29
readme.md Normal file
View File

@ -0,0 +1,29 @@
## Getting Started
These instructions will show you how to get a copy of the project and how to deploy the project on a live system.
Create web folder:\
`sudo mkdir -p /var/www/3d-app/`
Clone the repository to your web folder:\
`git clone https://github.com/geolba/GeotiefExplore.git /var/www/3d-app/`
Switch to the repo folder:\
`cd /var/www/3d-app/`
Copy the example env file and make the required configuration changes in the .env file
`cp .env.example .env`
`.env` - Environment variables can be set in this file
Configure your database connection in .env-file e.g.:
`nano .env`
```ini
NODE_ENV=production
```
Build production files:\
`npm run prod`
## License
This project is licensed under the MIT License - see the [license](LICENSE) file for details