Skip to content

RecoFach/frontend

Repository files navigation

Frontend

This is repository for the frontend for RecoFach application.

Frontend poster

Project setup

To install and run this repo locally for development perform following steps:

  1. Clone the repository.

  2. cd into needed folder.

  3. Install dependecies

    yarn install
  4. Create .env file and define following in it:

    • VUE_APP_API_URL - Url of your backend endpoint
    • VUE_APP_API_PORT - Port of your backend endpoint
    • VUE_APP_RECO_URL - Url of your recommendation endpoint
    • VUE_APP_RECO_PORT - Port of your recommendation endpoint
  5. Done.

Production

Follow these steps to create production-ready build. You will need docker have installed.

  1. Build the docker image. You need do pass enviroment variables to specify location of backend service. Ensure to replace api_url and api_port values with yours.

    docker build \
    --build-arg api_url="http://localhost" \
    --build-arg api_port="8080" \
    --build-arg reco_url="http://localhost" \
    --build-arg reco_port="2000" \
    -t recofach-frontend .
    
  2. Run the docker image. Ensure map 3000 port to needed one.

    docker run -p 3000:3000 \
    --name recofach-frontend recofach-frontend
    

Compiles and hot-reloads for development

To run development server - use following command:

yarn serve

Compiles and minifies for production

To run optimizations and minifications for production build simply use:

yarn build

If you want more optimization run:

yarn bmodern

It will create two bundles:

  1. Modern bundle targeting modern browsers that support ES modules
  2. and legacy bundle targeting older browsers that do not

For more details see documentation

Lints and fixes files

We use Airbnb config to keep our code clean, fast, readable and usable. Use following command to check if new code have code-style issues before push.

yarn lint

Customize configuration

See Configuration Reference.

About

A Vue.js frontend for RecoFach application

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published