Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/co-demos/solidata-frontend

Second draft of Solidata-frontend (cloned from EIG repo)
https://github.com/co-demos/solidata-frontend

nuxtjs vuejs2 vuetify

Last synced: 3 months ago
JSON representation

Second draft of Solidata-frontend (cloned from EIG repo)

Awesome Lists containing this project

README

        

SOLIDATA
frontend

-------



-------

![alt text](./screenshots/home_en.png "homepage (en)")

-------
## PRESENTATION

part 2b/3 of the TADATA! sofware suite ([ApiViz](https://github.com/entrepreneur-interet-general/CIS-front) / [Solidata_backend](https://github.com/entrepreneur-interet-general/solidata_backend) / [OpenScraper](https://github.com/entrepreneur-interet-general/OpenScraper) )

#### Building a public service for managing, consolidating, and sharing data

-------

## GOALS

- an intuitive UX to manage open data projects ;
- support for multilingual (english, french, spanish to begin with) ;
- allow you to consume data from your own csv/xls files or external APIs ;
- consolidate your data : apply your own datamodel, simplify columns, apply metadatas, ... ;
- share the consolidated datas on API endpoints with the level of openness you decide (opendata, commons, collective, private) ;
- manage all your data and your recipes by projects ;
- be able to manage projects by teams and share data/recipes/datamodels...

------

## DEVELOPPERS

Nice to see you around ! For a more complete tour check out :
- our *[guidelines](./GUIDELINES_DEV.md)*
- our *[changelog](./CHANGELOG.md)*
- our *[contribution guide](./CONTRIBUTING.md)*

--------

## TECHNICAL POINTS

#### Tech stack
- _Language_ : **[Javascript](https://www.python.org/)**... not my cup of tea but still...
- _Framework (js)_ : **[Vue.js](https://vuejs.org/)** and **[Nuxt.js](https://nuxtjs.org/)**... Universal Vue.js Applications
- _Framework (styles)_ : **[vuetify](https://vuetifyjs.com/)**... Material Design Component Framework
- _Requests_ : **[Axios module for nuxt](https://axios.nuxtjs.org/)**... Secure and Easy Axios integration with Nuxt.js.
- _Internationalization_ : **[i18n module for nuxt](https://nuxtjs.org/examples/i18n)**... do you speak french, english, spanish, turkish ?
- _Encryption_ : **[js-encrypt](http://travistidwell.com/jsencrypt/)**... RSA encryption when critical data is exchanged between back and front

#### Features :

- intuitive UX
- **multilingual** : FR, EN, ESP
- login / register
- import a **dataset** (dataset input) : from a file (csv, , xlsx) or from an external API
- manage / create **datamodel templates** (schemas) from datamodel fields
- manage / create **datamodel fields**
- manage / create **open data projects** : choose a datamodel, add several datasets and associate each with a datamodel, choose the level of open data for each datamodel field,solidify the compiled data with external API, export the compiled data (csv, or API endopoints)
- asymetrical **encryption** by RSA (password, email, ...) and JWT authentification (access and refresh tokens)

#### Features TO DO :
- tutorials (videos)
- RGPD compliance
- dataviz of a project (PRJ) - with Chart.js or D3.js
- map of a geolocalized project - with Leaflet

-------
## WHAT'S NEW ?

- check out our our *[changelog](./CHANGELOG.md)* for more details

-------

## BUILD SETUP

``` bash
# install dependencies
npm install # Or yarn install

# serve with hot reload at localhost:3000
npm run dev

# build for dev and launch server
npm run build_dev
npm start_dev

# build for production and launch server
npm run build
npm start

# build for preprod and launch server
npm run build_preprod
npm start_preprod

# generate static project
npm run generate
# or
npm run generate_preprod
# or
npm run generate_dev
```

For detailed explanation on how things work, check out the [Nuxt.js](https://github.com/nuxt/nuxt.js) and [Vuetify.js](https://vuetifyjs.com/) documentation.

--------

## BENCHMARK ETL (open source or proprietary)

Download the benchmark as a PDF file

![alt text](./screenshots/documentation/Tadata_uses_features_BENCHMARK_ETL.png "auth process")

--------

## DATA MODEL BACKEND

Download the datamodel as a PDF file

![alt text](./screenshots/documentation/Solidata_models_datamodels_map.png "auth process")

--------

## GLOBAL ARCHITECTURE & COMPONENTS

Download the global architecture schema as a PDF file

![alt text](./screenshots/documentation/Solidata-Models-collections.jpeg "auth process")

-------

## AUTHORIZATION PROCESS (access & refresh tokens)

Download the schema as a PDF file

![alt text](./screenshots/documentation/AUTH_PROCESS_fixed.jpeg "auth process")

-------

## CREDITS

#### Solidata's frontend team thanks :

- the [SocialConnect](https://entrepreneur-interet-general.etalab.gouv.fr/defi/2017/09/26/socialconnect/) project, aka "Carrefour des Innovations Sociales"
- the [EIG](https://entrepreneur-interet-general.etalab.gouv.fr/) program by [Etalab](https://www.etalab.gouv.fr/)
- the [CGET](http://www.cget.gouv.fr/)
- [Christophe Ninucci](https://github.com/chrnin) for his help, advices and taste for memes
- the [creator](https://github.com/noirbizarre) and community of [Flask RestPlus](https://github.com/noirbizarre/flask-restplus)

#### Contacts - maintainance :

- [Julien Paris](), developer (aka [JPy](https://twitter.com/jparis_py) on Twitter, or [Jpy](https://github.com/JulienParis) on Github)

-------

## SCREENSHOTS (UI/UX)

-------
Home page with the side menu

![alt text](./screenshots/home_en_menu.png "login & menu (en)")

-------
Login page

![alt text](./screenshots/login_en.png "login (en)")

-------
Main dashboard

![alt text](./screenshots/dashboard_en.png "dashboard (en)")

-------
Create a new project

![alt text](./screenshots/create_prj_en.png "create project (en)")

-------
Edit a project : add datasets, choose a datamodel, choose the visibiilty of each datamodel field for your project...

![alt text](./screenshots/edit_prj_en.png "edit project (en)")

-------
Map each of your project's datasets to your datamodel

![alt text](./screenshots/edit_prj_map_dsi_en.png "edit project (en)")

-------
Overview of all the datamodels shared and created by the community

![alt text](./screenshots/list_dmt_en.png "list datamodel templates (en)")

-------
Overview of all the datamodel fields created and shared by the community

![alt text](./screenshots/list_dmf_en.png "list datamodel fields (en)")

-------
Preview of a datasets uploaded by an user

![alt text](./screenshots/edit_dsi_en.png "edit dataset input fields (en)")

-------
Edit a datamodel

![alt text](./screenshots/edit_dmt_en.png "list datamodel template (en)")

-------
View of all the settings of a datamodel

![alt text](./screenshots/edit_dmt_settings_en.png "settings datamodel teamplate (en)")

-------
Edit a datamodel field

![alt text](./screenshots/edit_dmf_en.png "settings datamodel fields (en)")

-------
View of all the settings of a datamodel field

![alt text](./screenshots/edit_dmf_settings_en.png "settings datamodel fields (en)")