Code Climate QA

Maintainability

Test Coverage

Sauti Design Studio

You can find the latest deployed project at sautistudio.saustiafrica.org.

You can find the deployed project at Sauti Design Studio.

Contributors

Jason Belgard Phong Yang Michael Famurewa Ana Carillo Nicole White


Project Overview

Labs 22 Trello Board
Trello Board

Labs 22 Product Canvas
Product Canvas

Sauti Studio + Design is a desktop product that aims to serve the East African communities by providing a simple tool that will allow individuals with no programming skills to build and customise a text based app to share information and knowledge. Sauti Studio + Design encourages anyone who experience the problems stemming from lack of information to take a stand and design their own solutions by laying out a USSD text-flow that can be accessed via simple phone.

Essentially, Sauti Studio + Design is a digital tool that will provide a UI for building APIs designed to handle SMS/USSD requests. User's should be able to build a simplified "flow" which saves as a series of nodes and connections. This will also require thinking about the resulting API, which when sent a text query (with Session ID), returns the appropriate response. This REST API can then be integrated into Sauti’s country specific USSD aggregator.

Tech Stack

Front end built using:

React/Redux

Front end deployed to Amazon AWS

Back end built using:

Express/Node.js

  • Express has a large community of users.
  • Express is the most matured framework for Node.js with 5+ years of use.
  • Express offers a quick and simple way to get a server up and running.

APIs

Africa's Talking

  • Africa's talking was a no-brainer since our stakeholder's company is already using it in production.
  • Africa's talking also works with the ussd-menu-builder library which we are used to reduce workload.
  • Africa's talking services East Africa, which is our target audience.

Okta

  • Okta is the only approved identity and access management company per the Lambda School Engineering Standards
  • Okta is a trusted service that has been in buisness since 2009
  • Okta allows developers to build identity controls into applications, website web services and devices

Diagramming

Recently Developed by Dylan Voster, he is accessible via this Gitter Page.

A flow & process orientated diagramming library inspired by Blender, Labview and Unreal engine.

  • Modern Codebase written entirely in Typescript and React, the library makes use of powerful generics, advanced software engineering principles and is broken up into multiple modules.
  • Hackable and extensible the entire library including its core can be extended, rewired and re-assembled into fundamentally different software to suit your own software needs.
  • HTML nodes as a first class citizen the library was originally written to represent advanced dynamic nodes, that are difficult to represent as SVG's due to complex input requirements ux requirements.
  • Designed for process the library is aimed for software engineers that want to rewire their programs at runtime, and that want to make their software more dynamic.
  • Fast diagram editing the defaults provided give the heighest priority to editing diagrams as fast as possible.

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

*  REACT_APP_BE_API_URL='http://localhost:5000' OR Production Route 
*  REACT_APP_OKTA_DOMAIN=https://dev-YOURACCOUNT.okta.com
*  REACT_APP_OKTA_CLIENT_ID=00000000AAAAAAA

REACT_APP_BE_API_URL -- Set this to 'http://localhost:port' of your backend api if using locally. Otherwise, set it to your backend's URL.

REACT_APP_OKTA_DOMAIN -- Set this to your okta app's domain. You will need to sign up for an okta developer account and create an app. From there you will get your app's URL.

REACT_APP_OKTA_CLIENT_ID -- A string. Once you have your okta app created, under the client credentials section of your app's settings, you will find your client ID and client secret.

Installation Instructions

npm install - to install dependencies

npm start - to start local application

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project. Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.


Notes

Reset Password Page

When a user registers an account on the application, recovery questions and answers are not required, therefore a user cannot request a self-service password reset because by default okta requires a recovery question and recovery answer to reset a password.

The email sent to a user when resetting their email will not be a self-service email until the setting within "password policy -> account recovery -> additional self-service recovery option -> security question" is unchecked. This option by default, when creating a new okta app, will not be available.

You MUST contact okta support, create a ticket, and ask them to enable this option for your application. Once this option is available you can uncheck the option and save.

A New Okta App Must Be Created

In order for you to have access to the okta application and it's settings, you should create your own okta application and update the environment variables to reflect the newly created okta application. Remember to contact Okta support to implement the self-service password reset noted in the notes section.

Heroku Backend Free Tier

Because we are currently using Heroku's free tier to host the backend and database, note that the service goes to sleep after a time of inactivity (30 minutes?) and requires a time of about 30 seconds to wake from sleep.