Home

Table of Contents

• About the project
• Installation
  • Clone
  • Setup
  • Required to install
  • Tools
• Usage
  • How to run local
  • How to run build
  • How to run tests
  • How to run linter
• Documentation
• Contributing
  • git flow
  • issue flow
• Team
• FAQ
• License

About the project

Home - is an all-in-one social service that will cover all aspects of your communication with your home and neighbors.

• Internal notification and news system

• Private messages, chat with selected residents and general OSBB group with all residents or OSBB's modules separately

• Residents independently form a budget, determine contributions for the maintenance of the house, the sequence of solving problems. This makes it possible to quickly respond to emergencies, to decide what needs to be done in the house or on the adjacent territory in the first place, to ensure the protection of the personal and common property of residents

• The ability to choose a service provider such as (water, electricity, gas), and pay utility bills

• The best offers and wishes can be implemented in the OSBB by residents through internal voting system

• Transparency of expense. The residents' funds go exclusively to the needs of their home and are spent rationally. The head of the OSBB reports directly to the residents, so they are always aware of what the funds were spent on

Installation

Clone

• Clone this repo to your local machine using https://github.com/ita-social-projects/Home-UI.git

Setup

$ npm install or npm i

for CI/CD

$ npm ci

Required to install

• NodeJS (>=14)
• npm (=>6)

Tools

Project	Package	Version	Links
Vue	vue
Vue Router	vue-router
Vuex	vuex
Axios	axios
PrimeVue	primevue
PrimeIcons	primeicons

Usage

How to run local

$ npm run serve

Navigate to http://localhost:8080/. The app will automatically reload if you change any of the source files.

How to run build

$ npm run build

How to run tests

$ npm run test:unit

How to run linter

$ npm run lint

Back-End part of the project

Here is the back-end part of our project: https://github.com/ita-social-projects/Home

Documentation

All documentation can be found in Wiki tab.

Contributing

Git flow

Step 1

• Option 1

  • 🍴 Fork this repo!

• Option 2

  • 👯 Clone this repo to your local machine using https://github.com/ita-social-projects/Home-UI.git

Step 2

• HACK AWAY! 🔨🔨🔨

Step 3

• 🔃 Create a new pull request using https://github.com/ita-social-projects/Home-UI .

Team

• Technical Expert of the project - maveric-ui
• Mentor of SoftServe ITA - so2niko

Contributors that have worked on this project:

FAQ

• How do I do specifically so and so?
  • No problem! Just do this.

License

• MIT license
• Copyright 2021 © SoftServe IT Academy.