README.md

icms-tools-front

About the project

The front-end single page application (SPA) of icms-tools, a project for various, smaller CMS-related utilities. Built with Vue and Vuetify

Getting started

Prerequisites

This project requires Node.js v14.0+ and npm v6.14+ to be installed locally

Installation

To get the project up and running, and view components in the browser, complete the following steps:

1. Download and install Node and npm
2. Clone this repo ( IMPORTANT: Use the --recurse-submodules flag ): git clone --recurse-submodules ssh://git@gitlab.cern.ch:7999/cms-icmsweb/icms-tools-front.git (SSH)
3. Copy the contents of the .env.local file. Create a .env file at the project's root directory and paste.
4. Install project dependencies: npm install
5. Start the development environment: npm run serve
6. Open your browser and visit http://localhost:8080

Development

When developing components, you may want assets automatically compiled and the browser to refresh automatically. To do this, run the following task:

• npm run dev

Create a static build

To create production ready static instance of this project run:

• npm run build -- --mode= < environment > This will create a dist directory into which the required files will be created. The --mode parameter will determine which .env. file will get included in the final build.

Development Tools

Linting

ESLint is used for linting. The project-specific configuration rules are contained in the .eslintrc.js file.

Formating

All of the project's code is automatically formatted by Prettier.