Sauti Databank

You can find our deployed project at: https://www.databank.sautiafrica.org/

Contributors

Russell Terry	Brandon Harris	Alex Miller
Cristina Edens	Guyton M.O.	Matthew Cebenka
Vincent Pagano	Joshua Hill	Moses Samuel
Lukas Jaronis	David Tauraso	Russell Terry
Dylan Mestyanek	Robert Carter	Sandra Kimball
Len Winkler	Candace Rossi	Timothy McGowen
Jason Aviles	Elise Spain	Gregory L Jordan Sr
Melanie Harris	Vijay Das	Azra Panjwani
Cash Globe	Christopher Lopez	Heymi Vanegas
Jonathan Erlich	Kimberlee Johnson	Mark La Monica

|

Project Overview

• Labs 21 Trello Board

• Product Canvases

• UX Design files

Sauti is a nonprofit that provides a platform for small traders in East African countries to look up realtime market data. Sauti also collects demographic data on these traders, but, until our Labs project, they didn't have a way to visualize that demographic data for researchers.

Using React, react-dropdown library, Apollo GraphQL, Nivo, and Sass on the front-end, our team helped Sauti make its data more helpful and useful for economic researchers and policy makers.

Key Features

A researcher interested in the Sauti Databank is able to see the following Key Demographic Data across all traders by selecting through a dropdown menu:

• Primary Language
• Country of Residence
• Age
• Cross-Border Trade as Primary Source of Income
• Primary Border Crossing
• Gender
• Education
• Border-Crossing Frequency
• Most Requested Procedures Commodity
• Most Requested Procedures Commodity Categories
• Requested Procedures for Destination (Imports to:)
• Most Requested Documents Information for Procedures
• Most Requested Agency Information for Procedures
• Origin of Traders' Goods
• Final Destination Country
• Final Destination Market
• Top Commodity
• Top Commodity Categories
• Exchange Rate Direction

Other key features include

• Payment processing through Paypal
• Data downloading into a CSV file
• User authentication and authorizatoin
• Admin dashboard to manage users
• Admin download for user information
• Social media sharing integration
• Expanded cross-filtering capabalities
• Ability to hide or show filters

Tech Stack

Front-end built using:

• React: Currently industry standard for web applications, using React let us manage displaying large amounts of data effectively by implementing Components.
• react-dropdown library: Helped us use an existing library for making the dropdown beautiful so that we could focus instead on the business logic and data that differentiates Sauti in the nonprofit space.
• Nivo: Built specifically for React and ontop of d3js, Nivo provides easily-used graph functionality to display accurate dipiction of the data being analyzed.
• Apollo: Built to interact with GraphQL backend API's well, Apollo is the platform that enables us to write queries that specify back-end requests which retreives data for smooth transitions in crossfiltration. We utilize Apollo-Boost wrapper for easy interaction between React front-end components and GraphQL back-end. -[Recharts.js] - Line graph, used on top of D3.js -[D3.js]: for Choropleth Map.
• Sass: A CSS compiler helped us iterate more quickly on styling with the efficient use of nesting.
• AG-Grid-React
• Material-UI
• Paypal

Front-end deployed to AWS.

Back-end built using:

• Node.js
• Apollo-Server-Express
• Knex
• GraphQL
• MySQL
• Jest

Our reasoning behind using the above tools for the back-end build is to make cross-filtering easy and efficient. Alongside Node and Express for operation set up, we are using the GraphQL framework which is a query manipulation language that requests specific data from the database using one single API endpoint.

APIs

• Paypal Subscriptions API
• Please see Back-end documentation here.

Testing

We tested the site in Chrome and Firefox using Jest.

Installation Instructions

• After cloning or pulling repository for the first time, run "yarn install" in the app directory called /sauti.
• Run "yarn start" in /sauti directory to start react app.

Other Scripts

• build - creates a build of the application
• test - runs tests in tests directory * eject - copy the configuration files and dependencies into the project so you have full control over them

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.

#######END