Frontend

Better Professor

You can find the deployed project at zeit.

Contributors

Phong	Yannick	Naomi	Devin

Project Overview

Trello Board

Product Canvas

UX Design files

Better Professor allows you to better organize, manage, and remind not just your students, but yourself.

Find the students that you are mentoring, and keep track of their progress on their assignments, projects, and research.

Create unique due dates that will automatically remind you and your students, when something is coming up or due with automated or custom messages!

Never miss an opportunity to mentor again!

Key Features

• Add Students You Want to Manage
• Edit/Delete Student Profiles
• Create Projects for Each Student
• Edit/Delete Projects Belonging to Students

Front end built using:

React

• Responsive by Nature
• Simple to Implement, Maintain, and Reuse
• User Experience

Front end deployed to zeit.co

Back end

Installation Instructions

• Outside users:
  

• Fork the frontend respository to your own repository on GitHub.
  

• Clone the forked repository into a folder on your computer.
  

• Download dependencies. With YARN, inside the terminal do `yarn install` - With NPM, inside the terminal do `npm install`
  

• Start the app. With YARN, in the terminal do `yarn start` - With NPM, inside the terminal do `npm start`
  

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.

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.