AdaptivApps

You can find the deployed project at adaptivapps.

Contributors

Madeline McIntosh	Josh Armantrout	Taylor Cool	Jimmy Mcbride	Jonathan Thec

Forrest Bingham	Robert Campbell	Amber Mohler	Ryan Sizemore	Priya Vaidya

Amanda Hogan

Project Overview

Product Canvas

UX Design files

Chat Design Files

A nonprofit organization and is looking for a better way to engage their staff, volunteers, athletes, parents, coaches and spectators. This app would need to be digitally accessible with the ability to meet various physical changes.

Key Features

User Onboarding
Create Events / Register for Events
Calendar / Map Features
Real-time Chat (Direct Messaging and Announcements)

Tech Stack

Front end

Front end built using:

React

Why did you choose this framework?

Easy to learn and use
Reusable components
Fast rendering with virtual DOM
Testability

Front end deployed to `AWS Amplify`

Setup with CI

Back end built using:

Prismatopia (GraphQL, Apollo, Prisma)

Generated CRUD Schema
GraphQL is fastest query slinger this side of the mississippi!
Built in Subscription services to handle real-time chat

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_CLIENT_ID=this is the client id found in our application that is being hosted on Auth0
REACT_APP_API_URL=can be found in the AWS Amplify application. This is the authentication API
REACT_APP_CLIENT_DOMAIN=auth0 domain for the AdaptivApps application
REACT_APP_AUDIENCE=auth0 endpoint for the AdaptivApps application
REACT_APP_WS_URL=websocket endpoint

Testing

We used Jest beacuse it has everything we need to unit test our application

Installation Instructions

Yarn install -> NOT npm install (several packages install dependencies and yarn installs all those project dependencies while npm will not) npm run start

If a terminal error occurs around babel-jest, delete the following folders:

node_modules
package-lock.json
yarn.lock

Remove babel-jest from package.json and run yarn install

Other Scripts

"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject",
"lint": "eslint"

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.

BloomTech-Labs/AdaptivApps-fe