Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Recommendations
3. Usage
4. Copyright
5. Contact

About The Project

This repository is the frontend codebase of Tumaini.

Built With

• Vue
• NodeJS

Getting Started

To run the frontend just follow these steps.

Prerequisites

There is a small number of steps you need to follow in order to get the frontend up and running.

• NodeJS (to install node we are using the node version manager short nvm)

  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
  nvm install node # "node" is an alias for the latest version

• Vue CLI

    npm install -g @vue/cli

Installation

1. Clone the repo

   git clone https://github.com/KaiserRuben/Tumaini.git

2. Install NPM packages

   npm install

Recommendations

• Webstorm

• Plugins:

  • Git Toolbox (For knowing who wrote the code your looking at)
  • Rainbow Brackets (For the sake of clarity)

Usage

For running the frontend in development mode simply run

npm run serve

The page will be available under http://localhost:8080.

To compile and minify the frontend for production run

npm run build

The compiled frontend can be found in the directory named "dist".

To run the local frontend in combination with the local backend you need to change dbOnline to false in src/config.js.

Copyright

Copyright (c) Tumaini 2020

Contact

• Tumaini
• Ruben Kaiser