For steps on how to work with this repository please see here
You can find the deployed project at c.storysquad.dev.
Feel free to contact any of the labs26 contributors below, or DM in Slack. We'd be happy to help you all get off the ground. We made some videos explaining alot of the site and the code as well. We handed those off to our TPL: Jacob Tharp.
You might need to DM Jacob Tharp to get access:
| Michael Barnes | John Daly | Scott Fuston | Dawson Hamm | Jesse Marek | Johan Mazorra | Jack Ross | Jacob Tharp |
|---|---|---|---|---|---|---|---|
 |
 |
 |
 |
 |
 |
 |
 |
| Web | Web | Web | Web | Web | DS | DS | TPL |
 |
|
|
|
|
|
|
|
- clone the repo to install it as your own remote.
- note please be sure to set your remote for this repo to point to your Labs Team Front End Repository.
- run:
npm installto download all dependencies. - run:
npm startto start your local development server.
When using Okta for authentication, the app will need to run locally on port 3000.
- Okta secure login
- Custom loading spinner
- Data driven handwriting recognition & analysis
- AWS Amplify
Back end built using:
- Multer middleware for handling image uploads via
mulipart/form-data - Image storage in S3 bucket on AWS
- PostgreSQL database
User Authentication for this project is handled by Okta. For reference you can access Okta's Docs here.
Payment processing and subscription integration in this project is handled by Stripe. For reference you can access Stripe's Docs here.
Global state management in this project is handled using Recoil.js. For reference on you can access the Recoil Docs here. There is also a README.md in the src/state/ folder that gives a brief overview with examples on how to utilize Recoil.
Clone the repo to your local machine
run npm i to install dependencies
run npm start to fire up the project.
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.
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.
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.
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.
- 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.
Back end repo See [Backend Documentation](🚫link to your backend API SWAGGER DOCS here) for details on the backend of our project.