Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 2.34 KB

README.md

File metadata and controls

89 lines (68 loc) · 2.34 KB
Raw

INDRZ Frontend

Gitlab hosts the main repo Mirror repo is at Github

This is the indrz FRONTEND repository. You can find our documentation project here indrz Docs in the folder content

Indrz is a web application for indoor wayfinding, mapping and routing. The platform is for example used by a University that wants to provide its guests, staff and students a web map platform to allow them to find anything on campus.

Quick setup for development

The running frontend code is of no real use without it's best friend the BACKEND API. Head over to get it started.

  1. Clone the repo git clone https://gitlab.com/indrz/indrz-frontend.git
  2. yarn install
  3. yarn run dev

If you have issues with your install these three little steps usually help

rm -rf node_modules
rm yarn.lock
yarn cache clean
yarn install

Git Commit Guide

  1. Create a branch from main
  2. Name the branch like 123-add-red-button where it starts with the issue number then a short name no spaces uses a -
  3. Commit small and often to your new branch, it helps for Quick code-reviews. Commit messages
  4. Create a merge request to main and reference the issue.

Customize Style

View the /assets/custom_css folder to find here you can place your custom css styles

Create production build

yarn generate

To bump the version number run any of the following commands:

To bump the major version

yarn generate.major

To bump the minor version

yarn generate.minor

To bump the patch version

yarn generate.patch

Now just copy the /dist folder to your favourite webserver or static file server to serve it up using nginx, S3, GCP cloud storage, Netlify, you name it.

Customize style

Floor changer

Run app using docker

  1. yarn docker-build

    And then,

  2. yarn docker-run

Playwright Setup

  1. Install Playwright Browsers
yarn create playwright
  1. Run playwright UI tests
yarn run pw:test
  1. Optional: Install Playwright VS Code extension for test debugging and trace viewer