Blitz Build

You can find the deployed project at Blitz Build.

Contributors

Frank Martinez-Team Lead	Graham Bunt-UX Designer	LC Carrier-Developer	Mike Harley-Developer	Connor Holly-Developer

Min Huang-Developer	Matthew Meeves-Developer	John Rojcewicz-Developer	Chariton Shumway-UX Designer

Project Overview

Trello Board

Product Canvas

UX Design files

Create a product that is simple and easy to use for non tech savvy user, with less noise than the competitors.

Key Features

• Dashboard To View Projects,Tasks,Documents and Weather
• Calendar To Remind You Of Important Tasks
• Premade Template To Get You Started
• Ability To Create Your Own Template
• Document Center To Upload and Store Important Documents

Tech Stack

Front end built using:

    React / Bootstrap

Why did you choose this framework?

• Created for UI
• Easily Manage State
• Works for Web and Mobile
• Huge Dev Following and Support
• It's What We've Been Using For the last 7 + months

Front end deployed to netlify

Back end built using: NodeJs

back end framework goes here

• Express
• PostgreSQL
• AWS

APIs

AUTH0

AUTH0 makes user registration and login easy. They handle all the work and send a jwt back to the frontend. They also store all user data.

Weather API

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_REDIRECT_URL - This is the approved callback domain setup thur Auth0. This needs to be added when in developemnet to work on local

Installation Instructions

git cloneto download this repo cdinto blitz-build-fe run yarn🐱ornpm installto install the dependencies. then npm run start or 🐱yarn start to start up the dev server.

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.