SignLingo

You can find the deployed project at thesignlingo.com. Also... we use YARN instead of NPM for this projects package manager. Remember to use Yarn.

Contributors

Labs 23

Joseph Nevarez	Erik Rodriguez	Cedric Winbush

Seth Cox	David Isakson	Kendra McKernan

Labs 24

Jackson Ogles	Natalia Beckstead	Bryan Bilek

Krisda Luengthada	Ryan Mecking	Cooper Vos

Wesley Mountford	Michael Famurewa	Kendra McKernan

🚫 more info on using badges here

Project Overview

Labs 24 Trello Board

Product Vision Doc

UX Design files

SignLingo is a sign language learning app/website for beginners. Current ASL digital learning platforms fail to leverage gamification. So SignLingo picks up where other platforms leave off. It uses gamification so that users have fun while learning!

Key Features

• Each level includes:
• Going through flash cards to memorize alphabet signs
• Going through exercises to practice signs
• Going through quiz with Hand Recognition Technology to assess understanding

Tech Stack

Front end built using:

React

• Declarative
• Component Based
• Renders proper Html using JSX
• Lightweight and has a very small API surface

Redux

• Predictable
• Centralized
• Debuggable
• Flexible

Libraries and Packages

react-redux | redux-logger | redux-thunk | redux-devtools-extension

• Global state-management

axios

• Easier to read responses than fetch

styling

• After creating a component, add a new style sheet in the src/scss folder. If you have installed all deps using yarn, use the script "yarn scss" in the terminal to watch all scss files. Works like a charm. There are also other styling techniques used by previous teams (material ui, useStyles, etc.), but labs 24 onward we have been using scss, making new scss files if needed.

• We store all images in the public folder. If you think you need to add images to this front end app, feel free to create a folder to put them inside. To access them and add them to a JSX image tag simply use process.env.PUBLIC_URL like so:
  <img src={process.env.PUBLIC_URL + '/images/yourFolder/yourImage.png'}> etc

Material UI

• Labs 23 used this for a few components for various reasons.

CUID

• Creates uniqe Id for mapping over data

React Card Flip

• Makes card flipping functionality more accessible

Formik

• Form management from before, now using okta authentication

Yup

• Form validation from before, now using okta validation

Inter UI

• For fonts

Okta Widget

• Okta Login and Register Form for Authentication

Front end deployed to Amazon Web Services

https://thesignlingo.com

Environment Variables Here

In order for the app to function correctly, the user must set up their own environment variables. The values of these .env vars can be found in the Product Vision Document in Notion. There should be a .env file containing the following:

REACT_APP_OKTA_DOMAIN REACT_APP_ISSUER REACT_APP_CLIENT_ID REACT_APP_REDIRECT_URI REACT_APP_MESSAGES_URL REACT_APP_BASE_URL REACT_APP_BACK_END_BASE_URL

Content Licenses Here

Image Filename	Source / Creator	License
ASL alphabet signs	Burst/Sarah Pflug	Burst

Testing

Jest was used to test the app because of its simplicity and its integration capabilities with Code Climate.

Installation Instructions

Clone this repo to your local machine. Run yarn install.

Other Scripts

* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **__tests__** directory 
* eject - copies the configuration files and dependencies into the project so you have full control over them
* coverage - creates a coverage report of test
* scss - continous sass compiler to watch scss code to turn into css code

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.