Giter Club home page Giter Club logo

energy-site's Introduction

PowerPlan

Created by Scott Nguyen


Mockup the build of materials and site layout of an Industrial Energy Battery site

  • Estimate the cost, land requirements, and energy density of a site
  • Visualize the plot of land and example battery layout
  • Save changes to revisit later

You can view a fully working demo at https://energy-site.vercel.app/.

Tech Stack

  • Web Application: Next.js + TailwindCSS hosted on Vercel
  • API: Vercel Serverless functions
  • Database: Supabase (PostgreSQL)
  • Auth: Supabase
  • Testing: Jest

How to run PowerPlan locally

Set up Supabase

  1. You'll first need a Supabase account which can be made https://supabase.com/dashboard/sign-up

  2. Create a new database and navigate to Settings > API to find your Project-URL and Anon-Key. You will add these to the web projects .env file

Start Next.js project

  1. Clone this repository and run:

    cd energy-site
    npm install
  2. Rename .env.example to .env and update the following:

    NEXT_PUBLIC_SUPABASE_URL=[your-project-url]
    NEXT_PUBLIC_SUPABASE_ANON_KEY=[your-anon-key]
    NEXT_PUBLIC_API_URL=[your-api-url] // localhost:8000
    
  3. You can now run the Next.js local development server:

    npm run dev

    PowerPlan should now be running on localhost:8000.

  4. To run the test suite:

    npm test

Features I would add to extend PowerPlan

  • Move Battery object to my database so we could add, edit, and delete different batteries. Currently, this is hard coded in the web app.
  • Randomize different layouts depending on constraints
  • Save sessions as individual sessions. Allows for comparisons of different plans
  • Configure constraints (50m, 200m, budget caps, etc.)

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.