diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..438a816 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022-2023 GeoVisio team + +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. diff --git a/README.md b/README.md index fff8b03..05e0572 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,90 @@ -# panoramax-website +# ![GeoVisio](https://gitlab.com/geovisio/api/-/raw/develop/images/logo_full.png) -This template should help get you started developing with Vue 3 in Vite. +__GeoVisio__ is a complete solution for storing and __serving your own 📍📷 geolocated pictures__ (like [StreetView](https://www.google.com/streetview/) / [Mapillary](https://mapillary.com/)). -## Type Support for `.vue` Imports in TS +➡️ __Give it a try__ at [panoramax.ign.fr](https://panoramax.ign.fr/) or [geovisio.fr](https://geovisio.fr/viewer) ! -TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types. +## 📦 Components -If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps: +GeoVisio is __modular__ and made of several components, each of them standardized and ♻️ replaceable. -1. Disable the built-in TypeScript Extension - 1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette - 2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)` -2. Reload the VSCode window by running `Developer: Reload Window` from the command palette. +![GeoVisio architecture](https://gitlab.com/geovisio/api/-/raw/develop/images/big_picture.png) -## Customize configuration +All of them are 📖 __open-source__ and available online: -See [Vite Configuration Reference](https://vitejs.dev/config/). +| 🌐 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) | -## Project Setup + +# 💻 GeoVisio Website + +This repository only contains __the web front-end of GeoVisio__. + +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). + +## Features + +The website offers these functionalities: + +- 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 + +## Install & running + +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 -yarn install -``` -### Compile and Hot-Reload for Development - -```sh -npm run dev -yarn dev -``` - -### Type-Check, Compile and Minify for Production - -```sh +# Ready-to-use build (available in /dist folder) npm run build -yarn build ``` -### Run Unit Tests with [Vitest](https://vitest.dev/) +## Develop + +Various commands can help you through the development on the website: ```sh -npm run workflows:unit +npm run dev # Compile & hot-reload +npm run workflows:unit # Unit testing +npm run lint # Code linting ``` -### Lint with [ESLint](https://eslint.org/) +### Customization -```sh -npm run lint -``` +You can change the title of your instance on the [locales folder](./src/locales) who regroup all the wordings. -## Instance customization +If you want to change the logo header you can replace the `logo.jpeg` in the [assets/images folder](./src/assets/images) to use yours. -You can change the title of your instance on the [locales folder](https://gitlab.com/geovisio/geovisio_website/-/tree/main/src/locales) who regroup all the wordings -If you want to change the logo 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 logo in jpeg with the same name file + +## Contributing + +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. + + +## 🤗 Special thanks + +![Sponsors](https://gitlab.com/geovisio/api/-/raw/develop/images/sponsors.png) + +GeoVisio was made possible thanks to a group of ✨ __amazing__ people ✨ : + +- __[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 ! + + +## ⚖️ License + +Copyright (c) GeoVisio team 2022-2023, [released under MIT license](./LICENSE).