sergioespana / open-sea Goto Github PK

• Within the settigs component, set input's defaultValue to the field within the user object (e.g., user.name).
• Use linkState to update within the settings component.
• Save only changed fields, setDoc will handle merging old and new values.

SEA methods are to be provided to the application through a YAML configuration file. The application will, after validating the configuration file, present the user with the appropriate input fields for the desired metrics. It will then compute the indicators.

Progress:

• Parse YAML file to a string
• Convert YAML string to JSON, making it easier to process in code
• Validate the JSON model using a predefined schema
• If invalid, display errors and don't store the model in the database

• Check if name already exists by using (slugify) and seeing if the document exists in DB
• Display error if it exists
• Create organisation if it does not exist
• Add user as owner for the newly created organisation
• Redirect user to newly created organisation

In other words, add some kind of validation. For example, when creating a new organisation you can submit the form with no organisation selected. The button should be disabled.

The system shall read from the indicator model file what type of visualisation mechanism the user wants for each indicator.
In the documentation, we should have a list of candidate visualisation mechanisms with a brief explanation of when each is convenient. E.g. number, percentage, bar chart, pie chart, line chart, etc.). The OZP by Ewan Klomp contains a discussion on visualisation mechanisms (not yet published), but it should be easy to find many more sources.
We will prioritise them to decide which to implement first.

Should be able to be dragged open/closed. Tapping any item or outside of the drawer should also close it.

This results in an unhandled exception where we're unable to get the user's organisations.

• Allow creation of a new organisation with the isNetwork label.
• Separate organisations from networks in all views
• Add setting in organisations to convert to network (removes all reports and data)
• Add setting to networks to add organisation

• User without account is able to register one with email and password
• User with existing account is able to login with email and password
• User is able to log in or create an account through Google
• Upon user creation, store some information in the database:
  • First name
  • Last name
  • Full name
  • Creation timestamp
  • E-mail address
• Upon user login, store some information in the database:
  • Last succesful login

Initially, we will just define a single role, the administrator , who has all permissions and can carry out all types of actions in SEAMan (e.g. set up an auditing project, enter data, view results in the dashboard). In following releases, we will support new roles and their corresponding permissions.

This is an example of what those roles could look like, but further investigation of user needs is required.

• Each auditing project will have one or several auditors, who are responsible for the auditing project and therefore have many permissions; e.g. set up auditing projects, enter data, view results in the dashboard.
• Interest groups are sets of users sharing some characteristic; e.g. employees, clients, suppliers, neighbours. They receive links to surveys where they can enter data (facts or subjective perceptions). They might also be granted permissions to view partial or final results of the auditing project (e.g. an infographic).
• Attesters are third party auditors who certify that the data and evidences collected during the audit are accurate and genuine. They have access to the results of the auditing process and usually carry out inquiries within the organisation and the relevant interest groups to make their assessment.

This results in the "no model present" warning flashing.

Rewrite

import { map, assign } from 'lodash'

to

import map from 'lodash/map';
import assign from 'lodash/assign';

• Allow giving the assessment a name
• Store assessment in DB

Text inputs already have this, but others need it as well.

Possibly move the entire Firebase action URL to a custom implementation, but at least make the "Forgot password?" link actually work and send a password reset e-mail.

Initially, the tool is stateless. Then it will be able to store one audit per organisation (user). Then it will allow to define auditing periods (e.g. year) and will store the information of each period. This will enable visualisation mechanisms #5 that show historic data and trends (e.g. line charts).

Add postbuild script that minifies and mangles using babel-minify.

Caused by mobx-react package incompatibility with Preact. May be solved by using another version or a different package such as mobx-observer or maybe the deprecated mobx-preact.

Current situation:

Obviously these need to be a lot smaller.

Create a custom Link component that functions like normal except it will set window.location when window.swHasUpdated is set to true, resulting in the user's window being refreshed not immediately when the update is ready, but when he/she navigates to the next page.

• App works when offline thanks to offline-plugin.
• Firebase errors are caught and handled appropriately.
• A notification is shown to the user that the app is offline.

Then, of course, the indicators that depend on an optional metric, should only show information if the value for the metric has been provided by the auditor

Each organisation has their own unique URL. Users with the appropriate rights will be able to enable sharing for this organisation in a number of ways:

• Sharing the dashboard / report to specified users
• Making the dashboard publicly available
• Assigning read-only access to the data in addition to the dashboard to specified users
• Adding organisation "administrators" / "assessors" that have full access to the dashboard and the data
• Transferring ownership of the organisation to an existing administrator or assessor

Move from a single file that holds all functionality to:

• fbStore that holds all Firebase related functions (setListener, getRef, etc)
• authStore that covers user authentication and access management
• orgStore will hold everything organisation related
• snackStore handles Snackbar notifications
• appStore handles app states such as loading or opening the drawer

Is the current license the right one?

• B Impact Assessment https://beta.bimpactassessment.net/login (from the B Labs of the B Corporation movement)
• Green IT assessment tool http://greenit.s-i.ch/en/dc (Swiss Informatics Society)
• STARS - Sustainability Tracking, Assessment & Rating System https://stars.aashe.org/accounts/login/?next=/tool/ (aashe)
• XES Social Balance (Balanç Social de la XES) http://ensenyaelcor.org/balanc-social-vaadin/login#!login (XES is a regional network of REAS, based in Catalonia)
• REAS Social Audit (Auditoría Social de REAS) www.auditoriasocial.net (this tool is used by REAS Euskadi, among other regions, and it used for the national aggregated report)
• Common Good Report https://www.ecogood.org/en/common-good-balance-sheet/common-good-matrix/ (click link and see resources below in the page) (from the Economy for the Common Good)
• S-CORE - Sustainability – Competency, Opportunity, Reporting & Evaluation http://www.sustainability-core.com/about (International Society of Sustainability Professionals)
• Program Sustainability Assessment Tool https://sustaintool.org (Washington University in St Louis)
• SoFi Software http://www.sofi-software.com/international/applications/sustainability-reporting/ Maybe request a live demo

• If this is the first assessment within the organisation, prompt user to upload model
• If a previous assessment exists that does have a model, ask user if he wants to use that one or upload a new model

• Only support one action: submission of the form
• Add default cancel button that just closes the dialog
• Button labels are variable

• Sector

I.e., comparing / competing with organisations within a network.

Quickly flashes back into appearance before being removed from the DOM.

Especially for things such as parsing the YAML file this is useful. We don't want users in the console ideally.

This will allow the app to be "installed" to Android users' phones.

Move away from having a Drawer component implement the material guidelines and implement app-specific routes and such. Instead, have a Drawer component that is imported and used in the app's Drawer component. Consider publishing the material components as a separate library.