Giter VIP home page Giter VIP logo

super-special-layout-generator's Introduction

(Super Special Layout Generator)[https://super-special-layout-generator.web.app/]

This is a tool to help folks generate layouts for given battery configurations. They need to be able to

  1. Determine the resulting budget, land size, and energy requirements
  2. View a mock site layout complete with the number of transformers that would be required
  3. Save and resume their sessions across cache clears (thus, we aren't using localstorage)

Design Decisions

The goal was to make this as simple as possible as a tech demo, but also provide something with potential to scale.

For the layout, this led to a simple input on the left, output viz on the right situation.

The calculated results from the input are co-located with them.

Architecture

Tech stack

  • Vite
  • React
  • Typescript
  • React Router
  • Firebase (quick to get started and host, persistent data made easy)
  • Material UI for the UI toolkit (fast, standard, familiar aesthetic)

Notes

  • Runs on port 8000 locally.
  • Authentication and persistence are handled through Firebase Realtime Database
  • MUI Box component is not performant but it sure is quick to prototype with

Future Work

  • Refactor code (seriously... move the viz into its own area of concern for one thing)
  • Visuals in general need a lot of work
  • Success/error messaging is not present at the moment (no indication that save succeeded for example)
  • Take control of auth UX
  • Analytics and telemetry
  • A/B testing
  • Ability to manage multiple builds at once (support users having multiple open build sessions at once)
  • Enable more authentication providers (built in to Firebase, easy to add. Docs available here)
  • Create an error page for routes not found (errorElement: <ErrorPage />,)
  • fix: When the height of the viz is greater than the visible container height, the scrollbar position affects the calculated footprint width

super-special-layout-generator's People

Contributors

maryschmidt avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.