README.md

Check Voisinage Interop'fibre is an application aimed at referencing FTTx clients disconnected during the intervention of a technician on a fiber distribution point (french naming: "point de mutualisation" or "PM")

This tool requires an access to a PM repository as well as to a system auditing the connection status of FTTx clients. Since docking to these two services is specific to each operator, it is not integrated into this solution.

The steps imagined for this application are:

1. Entering an intervention (requires a PM, and date and time of the start of the intervention)
2. Query of audit system as well as the connection status for the given PM
3. A Summary of all disconnected clients and customers having undergone disconnections / reconnections during the intervention

Table of contents

• Quick start
• Status
• Profiles
• Run FrontEnd
• Run BackEnd
• Copyright and license

Quick start

Several quick start options are available:

• Clone the repo: git clone https://github.com/BouyguesTelecom/CheckVoisinageInterop.git
• Using SSH: [email protected]:BouyguesTelecom/CheckVoisinageInterop.git
• With GitHub CLI: gh repo clone BouyguesTelecom/CheckVoisinageInterop

Status

What's included

Within the download you'll find the following directories and files. You'll see something like this:

CHECKVOISINAGEINTEROPFIBRE/
├── CHECKVOISINAGEINTEROPFIBRE/
└── CHECKVOISINAGEINTEROPFIBREAPI/

It is a web service achitecture project. Separated into a BackEnd (CHECKVOISINAGEINTEROPFIBREAPI) and a FrontEnd (CHECKVOISINAGEINTEROPFIBRE)

FrontEnd treeView :

CHECKVOISINAGEINTEROPFIBRE/
├── public/
│   ├── favicon.ico
│   └── index.html
└── src/
    ├── assets/
    ├── components/
    ├── mixins/
    ├── router/
    ├── services/
    ├── store/
    ├── types/
    ├── views/
    ├── App.vue/
    └── main.ts

BackEnd treeview :

├── CVI.API/
│   ├── Properties/
│   │   └── launchSettings.json
│   ├── Controllers/
│   │   ├── AdminController.cs
│   │   ├── AuthentController.cs
│   │   └── HomeController.cs
│   ├── SendWork/
│   ├── ViewModel/
│   ├── WebLogFiles/
│   ├── appsettings.json
│   ├── Program.cs
│   └── Startup.cs
│
├── CVI.DOMAIN/
│
├── CVI.INFRASTRUCTURE/
│
└── CVI.Service/

Profiles

In this application there is 3 different profiles:

Profile/Permissions	Administration	Export	Intervention	Photo	History
Administrateur	r-w	r	r-w	r-w	r
Consultation	--	r	r-w	r-w	r
Hotline	--	-	r-w	r-w	r

Run FrontEnd

Prerequisites:

Make sure you have installed all of the following prerequisites on your development machine:

• Node.js - Download & Install Node.js and the npm package manager. If you encounter any problems, you can also use this GitHub Gist to install Node.js.

After you recover the project, start by installing dependencies before launching your program. In terminal:

npm install

Now that you installed all the dependencies you can run the application:

Run
In terminal:

npm run serve

or

vue-cli-service serve

You can also use our predefined scripts (find them in package.json)

"scripts": {
    "serve": "vue-cli-service serve --open --skip-plugins @vue/cli-plugin-eslint",
    "build": "vue-cli-service build --skip-plugins @vue/cli-plugin-eslint",
    ...
  }

• the option --open is for open the interface in the browser once the project is ready.
• the option -skip-plugins for skipping some hard plugins.

Building your application:

npm run build -- --mode testing

Customize configuration

See Configuration Reference.

VUE_APP_BASE_URL=https://localhost:44305

Run BackEnd

Prerequisites:

• Sql Server installed in your host. By default the app will use a local SQL Data Base.
• An integrated development environment (IDE) that supports C# (we use Microsoft visual studio)
• .net core framework version 3.1
• Entity framework Core version 5.0.2

Run
In your visual studio :

• Set your CVI.API project as startup project.
• Run the solution by pressing F5.
• On first launch, a local database will be created and populated with seed data automatically.
• Seed data are located in folder Data under CVI.API project in seedData.sql file.
• Static notification objects were added in DataBenchAlarmsNotifications() method in InitializeDatabase.cs file under CVI.Infrastructure project.This data simulates the audit system response.
• To change database connection go to CVI.API/appsettings.json and change the connectionString section.

Copyright and license

Copyright 2020-2021 FITDev team under the License