Add readme

1 files changed, 55 insertions, 69 deletions

diff --git a/README.md b/README.md
index 1f9c130..7b33094 100644
--- a/README.md
+++ b/README.md
@@ -1,69 +1,55 @@
-# verden-ui
-
-## Build Setup
-
-```bash
-# install dependencies
-$ npm install
-
-# serve with hot reload at localhost:3000
-$ npm run dev
-
-# build for production and launch server
-$ npm run build
-$ npm run start
-
-# generate static project
-$ npm run generate
-```
-
-For detailed explanation on how things work, check out the [documentation](https://nuxtjs.org).
-
-## Special Directories
-
-You can create the following extra directories, some of which have special behaviors. Only `pages` is required; you can delete them if you don't want to use their functionality.
-
-### `assets`
-
-The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/assets).
-
-### `components`
-
-The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/components).
-
-### `layouts`
-
-Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/layouts).
-
-
-### `pages`
-
-This directory contains your application views and routes. Nuxt will read all the `*.vue` files inside this directory and setup Vue Router automatically.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/get-started/routing).
-
-### `plugins`
-
-The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use `Vue.use()`, you should create a file in `plugins/` and add its path to plugins in `nuxt.config.js`.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/plugins).
-
-### `static`
-
-This directory contains your static files. Each file inside this directory is mapped to `/`.
-
-Example: `/static/robots.txt` is mapped as `/robots.txt`.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/static).
-
-### `store`
-
-This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.
-
-More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/store).
+# Verden 🌐🎨
+
+This software is part of a project for the Web Programming course at UNICT.
+
+---
+
+This is an UI wrote in Vue.js for the backend of Verden. Here below you can read
+how to run locally this app and how to set up on production.
+
+# Development
+
+It works with Node v14.6 and Vue 2.
+
+1. Clone this repo
+   ```
+   git clone https://git.dcariotti.me/verden/verden-ui
+   ```
+2. Install packages
+   ```
+   cd verden-ui
+   npm i
+   ```
+3. Run server
+   ```
+   npm run dev
+   ```
+
+# Production
+
+This is a guide for a good deploy on a [Dokku](https://dokku.me) server, which
+deploys Verden on port 80.
+
+1. Log into the server and create a new app
+   ```
+   dokku apps:create verden
+   ```
+2. Set docker-options
+   ```
+   dokku docker-options:add build '--build-arg BACKEND_URL='
+   dokku docker-options:add build '--build-arg SENTRY_DSN='
+   dokku docker-options:add build '--build-arg SENTRY_RATE='
+   dokku docker-options:add build '--build-arg SENTRY_ENV='
+   ```
+3. Add a remote and push this code
+   ```
+   git remote add dokku dokku_user@your_server:verden
+   git push dokku main
+   ```
+4. Install [Let's Encrypt](https://github.com/dokku/dokku-letsencrypt)
+   ```
+   sudo dokku plugin:install https://github.com/dokku/dokku-letsencrypt.git
+   dokku config:set --no-restart verden DOKKU_LETSENCRYPT_EMAIL=your_email
+   dokku letsencrypt:enable verden
+   ```
+5. Enjoy Verden at `https://verden.<your-server>`