forked from Ivasoft/geovisio-website
110 lines
3.0 KiB
Markdown
110 lines
3.0 KiB
Markdown
# panoramax-website
|
|
|
|
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).
|
|
|
|
## Technologies
|
|
|
|
- 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
|
|
|
|
## Configuration
|
|
|
|
All the commands and packages used are available in the `package.json` file.
|
|
|
|
You can change the vite server configuration in the `vite.config.ts` file. See [Vite Configuration Reference](https://vitejs.dev/config/) if you need.
|
|
|
|
## Project Setup
|
|
|
|
**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 all dependencies :
|
|
|
|
```sh
|
|
npm install
|
|
```
|
|
|
|
or
|
|
|
|
```sh
|
|
yarn install
|
|
```
|
|
|
|
### 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
|
|
```
|
|
|
|
### 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)
|