Skip to content

LuminousVar/PLaNner

Repository files navigation

PLaNner

A web application to help you easily manage and monitor your electricity usage.

Overview

PLaNner is a web application designed to simplify your electricity transactions and provide a seamless experience in managing your power usage.

Objective

To build an intuitive and responsive user interface for the PLaNner platform using Vite and Svelte, providing users with an efficient and effective way to handle their electricity-related needs.


Prerequisites

Before you begin, ensure you have the following ready:

  • Bun: A fast JavaScript all-in-one toolkit.
  • PLaNner Backend API: The backend for this project must be set up and running. You can find it here: LuminousVar/backend-PLaNner.

Getting Started

Follow these steps to run this project in your local development environment.

Step 1: Set Up and Run the Backend

This frontend application requires the backend API to be running.

  1. First, clone and follow the setup instructions for the backend repository: https://github.com/LuminousVar/backend-PLaNner.
  2. Ensure the backend server is running (on http://localhost:5100) before proceeding to the next step.

Step 2: Clone This Frontend Repository

Next, clone this frontend repository to your local machine.

# Using HTTPS
git clone https://github.com/LuminousVar/PLaNner.git

# Or using SSH
git clone git@github.com:LuminousVar/PLaNner.git

# Navigate into the project directory
cd PLaNner

Step 3: Install Dependencies

Use bun to install all the required packages for the project.

bun install

Step 4: Run the Application

Run the development server for the Application

bun --bun run dev

The Vite development server will start. You can view the application in your browser.

Step 5: Access the Application

Open the following URL in your browser to see the result:

https://localhost:5173

About

A web application to help you easily manage and monitor your electricity usage.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published