Sauti Africa Market Price Data & API

You can find the deployed production site at Sauti Africa Market Data.

Staging deployment

Contributors

Labs 17

Team Lead - Angela La Salle Github
Adnan Chowdhury - Github
Alexis Carr - Github
Kathryn Roads - Github
Mariam Farrukh - Github
Michael Hart - Github
Miguel Peralta - Github
Shawn McManus - Github

Labs 19

Team Lead - Kayla Crow Github
Himmat Gill - Github
Bao Pham - Github

Project Overview

Labs 17 Trello Board
Labs 19 Trello Board

Product Vision Document
Product Canvases

Sauti Africa Market Prices & API provides an easy to use interface to view and acquire data from Sauti Africa internal databases, and an API which provides JSON responses for developers to use for any purpose.

Key Features

• Grid Table - ability for non-developer to acquire data from database and download it as CSV
• Documentation - Extensive resource covering features of API and details on the Grid Table
• API - Provides JSON responses via API Key Authentication with usage limits.

Tech Stack

• React
• ag-Grid
• Auth0
• SASS
• Semantic UI
• Reactstrap
• Express
• SQL
• Knex

Front end built using:

React

• Responsive & High Performance Single Page Application
• State Management done via React Hooks
• Easy to integrate many other third party such ag-Grid, Auth0, etc

ag-Grid

• Easy to integrate with React
• Contains easy to implement CSV feature for downloading data
• Draggable columns
• Framework agnostic

Cypress

• Comprehensive testing suite for React apps
• Allows E2E testing with Auth0 read here
• Allows to test features through third-party libraries as well

Front end deployed to Netlify

Back end built using the following Framework & Libraries:

• Node
• Express
• Redis
• Knex
• SQL
• SQLite3
• Postgres
• UUID API key generator
• JWT

APIs

Authentication

We use Auth0 for authentication. Auth0 documentation can be found here

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_GOOGLE_TRACKING_ID
• REACT_APP_HOST="localhost:3000"
• REACT_APP_AUDIENCE
• REACT_APP_DOMAIN
• REACT_APP_CLIENT_ID

Content Licenses

Image Filename	Source / Creator	License
All GIFs	Internal Recording	Free to use

Testing

Front-End Testing is done via Cypress.io and Backend Testing is done via supertest

Testing on the front-end requires a cypress.json and cypress.env.json file with the following information:

cypress.json

{
  "baseUrl": "http://localhost:3000",
  "chromeWebSecurity": false,
  "defaultCommandTimeout": 20000
}

cypress.env.json (substitute the corresponding values from your auth0 application)

   "auth_audience": "https://my_tenant.auth0.com/api/v2/",
   "auth_url": "https://my_tenant.auth0.com/oauth/token",
   "auth_client_id": "my_client_id",
   "auth_client_secret": "my_client_secret",
   "auth_username": "my_username",
   "auth_password": "my_password"
}

Your auth0 application should be configured with Classic Login, and Disable Clickjacking should be turned off in Tenant Settings -> Advanced. Social login is not supported for testing, only an account registered with email / password.

Installation Instructions

• Clone this repo
• yarn to install all required dependencies
• yarn start to start the local app deployment

Other Scripts

* format - runs prettier code formatter

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.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

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.