MySchool

You can find the deployed project here.

Contributors

Elysia Gabe	Dylan Collins	Sara Reidy	Marc Dandoy	Katrina Hernandez

Project Overview

Trello Board

Product Canvas

UX Design files

MySchool is a portfolio-building app for parents and students participating in homeschooling activities. We make it quick and easy to add schoolwork examples or activity information to a printable PDF. Based on the Maryland state requirements for homeschoolers, MySchool keeps materials organized for a successful submission to educational authorities.

Key Features

• A searchable record of portfolio articles -- one portfolio per student, organized by subject and date
• Administrative access for parents or teachers for all student portfolios associated with a family or group
• Optional account for students in a family or group -- limited to read or add abilities to prevent accidental deletion
• Export function to instantly download, share, or print an entire portfolio or time range in PDF form
• Activity monitoring graphic to quickly note progress on portfolio creation
• Notifications to users to keep portfolio maintenance on track

Tech Stack

Front end built using:

• React

• Chakra UI

• React was chosen for its ease of developer onboarding and large external library availability.

• Chakra UI was chosen for its focus on accessibility friendly components.

  • Accessibility is always an important consideration, even more so when it comes to applications in the realm of education.

Front end deployed to AWS Amplify

Back end built using:

Framework : Express

• Allows for rapid implementation
• No onboarding time concerns, all members were familiar with Express
• Excellent documentation and other sources available
• Stable, has been around for a while

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:

*  PORT - set to any valid local port number for running server locally
*  DB_ENV - set to "development" until ready for "production"
*  JWT_SECRET - you can generate this by using a python shell and running import random''.join([random.SystemRandom().choice('abcdefghijklmnopqrstuvwxyz0123456789!@#\$%^&*(-*=+)') for i in range(50)])
*  CLOUDINARY_NAME - this is your Cloudinary username
*  CLOUDINARY_API_KEY - this is generated in your Cloudinary account
*  CLOUDINARY_API_SECRET - this is generated in your Cloudinary account

Installation Instructions

1. Run npm install or yarn install to install all dependencies.

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 - copy the configuration files and dependencies into the project so you have full control over them

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.