panoramax-website

Welcome to the Panoramax website documentation ! Panoramax is a website where you can upload a lots of photos to see them in map web viewer based on Geovisio.

Technologies

• Frontend website made in Vue 3
• Project use Vite 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
• Typescript used to type
• Jest 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 if you need.

Project Setup

You need to have Nodejs installed Node version : >=18.13.0

You need to have Npm installed

You can use npm or yarn as package manager

Install all dependencies :

npm install

or

yarn install

Compile and Hot-Reload for Development

Launch your dev server :

npm run dev

or

yarn dev

Run Unit Tests with Vitest

npm run test:unit

or

yarn test:unit

Lint with ESLint

npm run lint

or

yarn lint

Build in Production

In your production app, you must set some env variables like the .env.example file here

npm install
npm run build
npm run start

or

yarn install
yarn build
yarn start

Instance customization

Wordings

• All the wordings of the website are on this locale file
• You can change the title "title": "Instance Panoramax IGN" of your instance on the locale file
• In the same locale file 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

Images

• If you want to change the logo in the header you can replace the logo.jpeg in the assets/images folder file by your own jpeg logo with the same file name
• You can change the favicon inside the static folder