Update docs

.env

@@ -1,2 +0,0 @@
-VITE_API_URL=https://geovisio-backend-dev.osc-fr1.scalingo.io/
-VITE_ENV=dev

.gitlab-ci.yml

@@ -34,6 +34,8 @@ test:e2e:
   script:
     - yarn install
     - ./node_modules/.bin/cypress install
+    - echo "VITE_API_URL=https://geovisio-proxy-dev.osc-fr1.scalingo.io/" > .env
+    - echo "VITE_ENV=dev" >> .env
     - PORT=5173 yarn start &
     - yarn test:e2e
   coverage: /All files[^|]*\|[^|]*\s+([\d\.]+)/

README.md

@@ -1,109 +1,60 @@
-# panoramax-website
+# ![GeoVisio](https://gitlab.com/geovisio/api/-/raw/develop/images/logo_full.png)
 
-Welcome to the Panoramax website documentation !
-[Panoramax](http://panoramax.ign.fr/) is a website where you can upload a lots of photos to see them in map web viewer based on [Geovisio](https://gitlab.com/geovisio).
+__GeoVisio__ is a complete solution for storing and __serving your own 📍📷 geolocated pictures__ (like [StreetView](https://www.google.com/streetview/) / [Mapillary](https://mapillary.com/)).
 
-## Technologies
+➡️ __Give it a try__ at [panoramax.ign.fr](https://panoramax.ign.fr/) or [geovisio.fr](https://geovisio.fr/viewer) !
 
-- Frontend website made in [Vue 3](https://vuejs.org/guide/introduction.html)
-- Project use [Vite](https://vitejs.dev/guide/) who offer a fast development server and an optimized compilation for production (like webpack)
-- The style is made with CSS/SASS and the [bootstrap library](https://getbootstrap.com/)
-- [Typescript](https://www.typescriptlang.org/) used to type
-- [Jest](https://jestjs.io/fr/) used for unit testing
+## 📦 Components
 
-## Configuration
+GeoVisio is __modular__ and made of several components, each of them standardized and ♻️ replaceable.
 
-All the commands and packages used are available in the `package.json` file.
+![GeoVisio architecture](https://gitlab.com/geovisio/api/-/raw/develop/images/big_picture.png)
 
-You can change the vite server configuration in the `vite.config.ts` file. See [Vite Configuration Reference](https://vitejs.dev/config/) if you need.
+All of them are 📖 __open-source__ and available online:
 
-## Project Setup
+|                               🌐 Server                                 |                      💻 Client                       |
+|:-----------------------------------------------------------------------:|:----------------------------------------------------:|
+|                 [API](https://gitlab.com/geovisio/api)                  |    [Website](https://gitlab.com/geovisio/website)    |
+|            [Blur API](https://gitlab.com/geovisio/blurring)             | [Web viewer](https://gitlab.com/geovisio/web-viewer) |
+| [GeoPic Tag Reader](https://gitlab.com/geovisio/geo-picture-tag-reader) |   [Command line](https://gitlab.com/geovisio/cli)    |
 
-**You need to have [Nodejs installed](https://nodejs.org/en/download)**
-Node version : >=18.13.0
 
-**You need to have [Npm installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)**
+# 💻 GeoVisio Website
 
-You can use npm or [yarn](https://yarnpkg.com/) as package manager
+This repository only contains __the web front-end of GeoVisio__.
 
-Install all dependencies :
+Note that the 📷 __web viewer__ (component showing pictures and their location on a map) is in [a separate, dedicated repository](https://gitlab.com/geovisio/web-viewer).
 
-```sh
-npm install
-```
+## ⚙️ Features
 
-or
+The website offers these functionalities:
 
-```sh
-yarn install
-```
+- Display of pictures and their location (using the embed [web viewer](https://gitlab.com/geovisio/web-viewer))
+- Handle user authentication and account management
+- Show simple to read documentation
 
-### Compile and Hot-Reload for Development
+## 🕮 Documentation
 
-Launch your dev server :
+[A full documentation](./docs/) is available to help you through the install, setup and usage of the GeoVisio website.
 
-```sh
-npm run dev
-```
+## 💁 Contributing
 
-or
+Pull requests are welcome. For major changes, please open an [issue](https://gitlab.com/geovisio/website/-/issues) first to discuss what you would like to change.
 
-```sh
-yarn dev
-```
+## 🤗 Special thanks
 
-### Run Unit Tests with [Vitest](https://vitest.dev/)
+![Sponsors](https://gitlab.com/geovisio/api/-/raw/develop/images/sponsors.png)
 
-```sh
-npm run test:unit
-```
+GeoVisio was made possible thanks to a group of ✨ __amazing__ people ✨ :
 
-or
+- __[GéoVélo](https://geovelo.fr/)__ team, for 💶 funding initial development and for 🔍 testing/improving software
+- __[Carto Cité](https://cartocite.fr/)__ team (in particular Antoine Riche), for 💶 funding improvements on viewer (map browser, flat pictures support)
+- __[La Fabrique des Géocommuns (IGN)](https://www.ign.fr/institut/la-fabrique-des-geocommuns-incubateur-de-communs-lign)__ for offering long-term support and funding the [Panoramax](https://panoramax.fr/) initiative and core team (Camille Salou, Mathilde Ferrey, Christian Quest, Antoine Desbordes, Jean Andreani, Adrien Pavie)
+- Many _many_ __wonderful people__ who worked on various parts of GeoVisio or core dependencies we use : 🧙 Stéphane Péneau, 🎚 Albin Calais & Cyrille Giquello, 📷 [Damien Sorel](https://www.strangeplanet.fr/), Pascal Rhod, Nick Whitelegg...
+- __[Adrien Pavie](https://pavie.info/)__, for ⚙️ initial development of GeoVisio
+- And you all ✨ __GeoVisio users__ for making this project useful !
 
-```sh
-yarn test:unit
-```
 
-### Lint with [ESLint](https://eslint.org/)
+## ⚖️ License
 
-```sh
-npm run lint
-```
-
-or
-
-```sh
-yarn lint
-```
-
-### Build in Production
-
-In your production app, you must set some env variables [like the .env.example file here](https://gitlab.com/geovisio/website/-/blob/main/.env.example)
-
-```sh
-npm install
-npm run build
-npm run start
-```
-
-or
-
-```sh
-yarn install
-yarn build
-yarn start
-```
-
-## Instance customization
-
-### Wordings
-
-- All the wordings of the website are on this [locale file](https://gitlab.com/geovisio/website/-/blob/main/src/locales/fr.json)
-- You can change the title `"title": "Instance Panoramax IGN"` of your instance on the [locale file](https://gitlab.com/geovisio/website/-/blob/main/src/locales/fr.json)
-- In the same [locale file](https://gitlab.com/geovisio/website/-/blob/main/src/locales/fr.json) you can change the meta data wordings inside the `"meta": {}` object
-- You can change the instance name inside the documentation of the page /partager-des-photos for the keys `"terminal_text_logged"` and `"terminal_text_not_logged"` on the [locale file](https://gitlab.com/geovisio/website/-/blob/main/src/locales/fr.json)
-
-### Images
-
-- If you want to change the logo in the header you can replace the logo.jpeg in the [assets/images folder](https://gitlab.com/geovisio/geovisio_website/-/tree/main/src/assets/images) file by your own jpeg logo with the same file name
-- You can change the favicon [inside the static folder](https://gitlab.com/geovisio/website/-/tree/main/static)
+Copyright (c) GeoVisio team 2022-2023, [released under MIT license](./LICENSE).

docs/01_Start.md

@@ -0,0 +1,29 @@
+# GeoVisio Website hands-on guide
+
+![GeoVisio logo](https://gitlab.com/geovisio/api/-/raw/develop/images/logo_full.png)
+
+Welcome to GeoVisio __Website__ documentation ! It will help you through all phases of setup, run and develop on GeoVisio Website.
+
+__Note that__ this only covers the Website / front-end component, if you're looking for docs on another component, you may go to [this page](https://gitlab.com/geovisio) instead.
+
+Also, if at some point you're lost or need help, you can contact us through [issues](https://gitlab.com/geovisio/website/-/issues) or by [email](mailto:panieravide@riseup.net).
+
+
+## Architecture
+
+The website relies on the following technologies and components:
+
+- Frontend website made in [Vue 3](https://vuejs.org/guide/introduction.html)
+- Project use [Vite](https://vitejs.dev/guide/) who offer a fast development server and an optimized compilation for production (like webpack)
+- The style is made with CSS/SASS and the [bootstrap library](https://getbootstrap.com/)
+- [Typescript](https://www.typescriptlang.org/) used to type
+- [Jest](https://jestjs.io/fr/) used for unit testing
+
+
+## All the docs
+
+You might want to dive into docs :
+
+- [Install and setup](./02_Setup.md)
+- [Change the settings](./03_Settings.md)
+- [Work on the code](./09_Develop.md)

docs/02_Setup.md

@@ -0,0 +1,46 @@
+# Setup
+
+## System requirements
+
+**You need to have [Nodejs installed](https://nodejs.org/en/download)**
+Node version : >=18.13.0
+
+**You need to have [Npm installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)**
+
+You can use npm or [yarn](https://yarnpkg.com/) as package manager
+
+## Install
+
+The website can be installed locally by retrieving this repository and installing dependencies:
+
+```sh
+# Retrieve source code
+git clone https://gitlab.com/geovisio/website.git
+cd website/
+
+# Install dependencies
+npm install
+```
+
+## Build for production
+
+Before building, you need to define a bit of settings. At least, you have to create a `.env` file and edit its content.
+
+```sh
+cp env.example .env
+```
+
+More details about settings [can be found in docs here](./03_Settings.md).
+
+Then, building for production can be done with these commands:
+
+```sh
+npm run build
+PORT=3000 npm run start
+```
+
+The website is now available at [localhost:3000](http://localhost:3000).
+
+## Next steps
+
+You can check out [the available settings for your instance](./03_Settings.md).

docs/03_Settings.md

@@ -0,0 +1,43 @@
+# Settings
+
+Many things can be customized in your GeoVisio Website.
+
+## Basic settings
+
+Low-level settings can be changed through the `.env` file. An example is given in `env.example` file.
+
+Available parameters are:
+
+- `VITE_API_URL`: the URL to the GeoVisio API (example: `https://geovisio.fr`)
+- Settings for the work environment:
+  - `NPM_CONFIG_PRODUCTION`: is it production environment (`true`, `false`)
+  - `YARN_PRODUCTION`: same as below, but if you use Yarn instead of NPM
+  - `VITE_ENV`: `dev`
+
+More settings are available [in official Vite documentation](https://vitejs.dev/guide/env-and-mode.html#env-files)
+
+Note that you can also change the _Vite_ server configuration in the `vite.config.ts` file. See [Vite Configuration Reference](https://vitejs.dev/config/) if you need.
+
+## Wording customization
+
+GeoVisio website can be customized to have wording reflecting your brand, licence and other elements.
+
+All the wordings of the website are on this [locale file](./src/locales/fr.json). In there, you might want to change:
+
+- The website title (properties `title` and `meta.title`)
+- The description (property `meta.description`)
+- The used API URL (property `pages.upload.terminal_text`)
+- Links to help pages:
+  - `upload.description`
+  - `upload.footer_description_terminal`
+
+## Visuals
+
+The following images can be changed to make the website more personal:
+
+- Logo: [`src/assets/images/logo.jpeg`](../src/assets/images/logo.jpeg)
+- Favicon: [`static/favicon.ico`](../static/favicon.ico)
+
+## Next steps
+
+You may be interested [in developing on the website](./09_Develop.md).

docs/09_Develop.md

@@ -0,0 +1,43 @@
+# Work on the code
+
+## Available commands
+
+Note that all the commands and packages used are available in the `package.json` file.
+
+### Compile and Hot-Reload for Development
+
+Launch your dev server :
+
+```sh
+npm run dev
+```
+
+or
+
+```sh
+yarn dev
+```
+
+### Run Unit Tests with [Vitest](https://vitest.dev/)
+
+```sh
+npm run test:unit
+```
+
+or
+
+```sh
+yarn test:unit
+```
+
+### Lint with [ESLint](https://eslint.org/)
+
+```sh
+npm run lint
+```
+
+or
+
+```sh
+yarn lint
+```

src/components/Header.vue

@@ -92,6 +92,7 @@ import BetaText from '@/components/BetaText.vue'
 const { cookies } = useCookies()
 const { t } = useI18n()
 const route = useRoute()
+console.log(route)
 defineProps({
   authEnabled: { type: Boolean, default: true },
   userProfileUrl: { type: String, default: null }