Skip to content

Latest commit

 

History

History
249 lines (178 loc) · 29.5 KB

README.md

File metadata and controls

249 lines (178 loc) · 29.5 KB
Raw

Story Squad Team A

Maintainability Test Coverage

Story Squad turns “reluctant readers” into authors and illustrators through a collaborative world-building game.

You can find the deployed project at: AWS Amplify

Current State Of The App

Work done by Labs32: https://docs.google.com/document/d/1aSt8nd0Mg_2lcXzV9of9Bkd4DsLA-KMbRKVbyIDBnEc/edit Work done by labs29: Click Here

Project Overview

How the App should work - A primer for devs
Labs31 Product Roadmap
Labs27 Frontend video
Labs28 Progress/Starting point video
Labs27 Backend video
Labs26 Product Roadmap
UX Design
Architecture Layout

Welcome to Story Squad! We are an interactive learning platform targeted at grade school children, and we help build reading comprehension as well as artistic, writing, and analytical/critical thinking skills through weekly competitions.

Each week features a new chapter in an exciting novel, written and serialized specifically for Story Squad by author and educator Graig Peterson. Children are provided with prompts based on the chapter they've just read, and participants are then divided into teams of two. Students create art and fanfiction to match the prompt, before going head to head in a bracket-style tournament.

In addition to growing their literary and artistic skills, students learn team building and critical thinking skills through a unique voting system, where each child must weight their own work against their teammate in order to increase their odds of winning. Badges and points incentivize winning and encourage participation.

Story Squad is a paid service; parents are required to create the account for their children and pay a monthly subscription fee in order for their children to compete. This brings the platform into compliance with COPPA and ensures a long future for the project.

Contributors

Charlene Johnson Rob Lark Tucker Leach Stephanie Mairena Brittany Mclaughlin Ryan Mersmann Mosharraf Musa Patrick Oliver Sara Cearc
Web Web Web Web Web Web Web Web Team Lead
Brandon Ramirez Schrese Holloway Nick Ohman James Clark Sandra Coburn
Web Web Web Web Web
Dalton Miller Nate Cowley Jorge Manzur Emilio Ramirez
Web Web Web Web
Lori Schlatter Joseph Wilson Steven Chase Trevor Martin
Data Science Data Science Data Science Project Manager

Key Features

  • A Custom, Serialized Novel geared toward children in 3rd-6th grade
  • Parental Controls which allow parents to add and customize child accounts

Tech Stack

Front end built using:

React

  • First Class Performance with Virtual DOM
  • Lightweight Library resulting in low bundle size/improved load times
  • Easy cross-platform development via progressive web app
  • Simple routing

Ant Design

  • A set of high-quality React components out of the box
  • Powerful theme customization
  • Whole package of design resources and development tools

React Plotly

  • Easy to use to embed D3 charts
  • This React component takes the chart type, data and styling as Plotyly.JSON in its data and layout props, then draws the chart using Plotly.js.

Redux state management

  • Redux helps you write applications that behave consistently,
  • Centrilize your application's state and logic
  • The Redux DevTools make it easy to trace bugs

Backend built using:

Express

  • Built in routing and middleware
  • Useful add-ons such as helmet and CORS

Swagger Editor Documentation

  • Defines and documents RESTful APIs

API's

JWT & BCrypt

JSON Web Tokens are an industry standard authentication solution. Paired with BCrypt for hashing passwords, this allows secure local password authentication without reliance on third party solutions.

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:

*  BROWSER=none
*  REACT_APP_ENDPOINT=http://localhost:3000

Testing

Jest

  • Simple testing
  • Mocking of dependencies
  • Promotes consistent unit testing

Installation Instructions

Clone repo

git clone https://github.com/Lambda-School-Labs/story-squad-fe-b.git

cd story-squad-fe-b/

Install Dependencies

## Setting up the App
Front End:
- npm install
- add a new .env file with the info provided by your TPL
- npm start
- -open localhost:3000
Back End
- npm install
- add a new .env file with the info provided by your TPL (if you are using something other than Docker (like Postgres), add it to your backend .env file instead of the docker url
- npm start

Run Test

npm test

Clone and download the backend

Follow backend set up guides

Run the application locally

npm dev

Other Scripts

* build - creates a build of the application
* dev - runs the development server
* test - runs tests as defined in *.spec.ts files
* lint - format and correct errors with prettier

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.

Check this document from labs28 for what's been done/worked on, and what needs to be done. This will give you a good idea on where to start with your contributions. IMPORTANT! Please update for the benefit of future developers.

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

  • 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.

  • Please see Labs Gitflow for proper flow on all your pull requests.

Documentation

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


MIT React code style: prettier

#Follow up notes for next cohort Note for the Parent Dashboard “Change email” and “Change password” modals:

  • The modals are to have a lockout feature that disables and obscures their buttons with an opacity styling. This feature is still pending completion.
  • Also, the modal’s “Cancel” and “Save” buttons themselves still lack functionality (the latter of which will need to be added with Okta).