Skip to content

labs15-well-done/frontend

Repository files navigation

Well-Done

You can find the deployed project at Well-Done.

Contributors

Jean-Francois Sebagh Josh Diamond Andrew Brudnak Joshua Wood Maksim Vakarchuk


MIT React Next.js Prismic Emotion Netlify Status

Project Overview

Trello Board

Product Canvas

Design Files

A dashboard application to allow an NPO and it's clients to monitor current water pump statuses in Cambodia.

  • Built a server side rendered React application using Next.js

  • Utilized Hooks to manage state.

  • Setup a headless CMS using Prismic.

  • Utilized Emotion for lightweight styling.

An important aspect of this dashboard was making sure that it was as lightweight as possible for fast rendering, as well as limited requests to the endpoint.

Key Features

  • Overview of pump statuses
  • Full in-depth information about individual pumps
  • Access reports for onsight technicians
  • Lightweight
  • Easy to scale without touching code

Tech Stack

Front end built using:

React.js / Next.js

  • Automatic code splitting, doesn't load unecessary code.
  • Simple client-side routing.
  • Server Side Rendering for faster page loads.

Emotion

  • Requires no additional setup.
  • Lightweight, only loads visible css rather than everything.

Front end deployed to Well-Done.

CMS built using:

Prismic

  • Easy to use.
  • Scalable
  • Doesn't require touching code, allowing stakeholders to add new pumps quickly.

Content Licenses

Image Filename Source / Creator License
Icons kamijin-fanta License

Installation Instructions

  • Clone repo and install dependencies npm i
  • Run development npm run dev

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.