Update gitignore, update README.md

.gitignore

@@ -1,104 +1,29 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
+.DS_Store
+node_modules
+/dist
 
-# Optional eslint cache
-.eslintcache
 
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
+# local env files
 .env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# Next.js build output
-.next
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and *not* Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
+.env.local
+.env.*.local
+.env.production
 
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+.firebase
+.iml
+COVID-Bouncer.iml
+covid-bouncer-admin.iml

README.md

@@ -1,2 +1,73 @@
 # COVID-Bouncer-Admin
 Administration of [COVID-Bouncer](https://github.com/Sybit-Education/COVID-Bouncer)
+
+[![Sybit](https://img.shields.io/badge/-Sybit-b71583.svg)](https://www.sybit.de/)
+[![vue2](https://img.shields.io/badge/vue-2.x-brightgreen.svg)](https://vuejs.org/)
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/Sybit-Education/COVID-Bouncer-Admin/blob/main/LICENSE)
+
+## Solution
+
+The app is a Vue.js app. For this hackathon we wanted to try two main technologies:
+
+* Vue.js
+* Google Firebase to persist data
+
+## Development
+```
+npm install
+```
+
+### Compiles and hot-reloads for development
+```
+npm run serve
+```
+
+### Compiles and minifies for production
+```
+npm run build
+```
+
+### Lints and fixes files
+```
+npm run lint
+```
+
+### Configuration of Firebase
+
+You have to add `.env` file in the root directory having following environment variables:
+
+```javascript
+VUE_APP_FIREBASE_API_KEY="API-Key"
+VUE_APP_FIREBASE_AUTH_DOMAIN="xxxx"
+VUE_APP_FIREBASE_DATABASE_URL="xxx"
+VUE_APP_FIREBASE_PROJECT_ID="xxx"
+VUE_APP_FIREBASE_STORAGE_BUCKET="xxxx"
+VUE_APP_FIREBASE_MESAGING_SENDER_ID="xxx"
+VUE_APP_FIREBASE_APP_ID="xxxx"
+VUE_APP_FIREBASE_MEASUREMENT_ID="xxxx"
+```
+You will get the values if you create a web application for Google Firestore.
+
+## Deployment setup
+### Before 
+```
+npm install -g firebase-tools
+```
+```
+firebase login
+```
+### Deploying a Vue Site with Firebase Hosting
+https://www.youtube.com/watch?v=a-0W40NM0dI
+
+## Manually deployment
+### Serve before deploy
+```javascript
+npm run test-deploy
+```
+```javascript
+npm run deploy
+```
+
+## License
+
+[MIT License](LICENSE)