An open API service indexing awesome lists of open source software.

https://github.com/jane-does-coding/lumea

Track, reduce, and breathe cleaner air! 🌿
https://github.com/jane-does-coding/lumea

Last synced: 7 months ago
JSON representation

Track, reduce, and breathe cleaner air! 🌿

Awesome Lists containing this project

README

          

# 🌿 Carbon Footprint Calculator

> Track, reduce, and breathe cleaner air!

## 📋 Table of Contents

- [✨ Overview](#-overview)
- [🚀 Features](#-features)
- [📄 Pages](#-pages)
- [🛠️ Tech Stack](#️-tech-stack)
- [🔤 Fonts](#-fonts)
- [⚙️ Installation](#️-installation)
- [🎯 Purpose](#-purpose)
- [🤝 Contributing](#-contributing)

## ✨ Overview

A modern Next.js application that calculates your carbon footprint based on lifestyle factors like transportation, diet, and energy usage. The calculator provides:

- Detailed breakdown of emissions by category
- Visual comparisons to global and US averages
- Personalized recommendations for reduction
- Responsive design with smooth animations

Built with Next.js for optimal performance and clean UI design principles.

## 🚀 Features

| Category | Details |
| --------------- | ------------------------------------------------------------------- |
| **Calculator** | Transportation, diet, housing, energy, flights, and shopping inputs |
| **Results** | Comparative analysis, actionable recommendations |
| **UI/UX** | Responsive design, animated transitions, accessible color schemes |
| **Performance** | Optimized bundle size, lazy loading, efficient state management |

## 📄 Pages

- 1. Home/Landing Page (`/`)

- 2. Calculations Page (`/calculate`)

## 🛠️ Tech Stack

[![Technologies](https://skillicons.dev/icons?i=css,ts,tailwind,nextjs,react,git,github)](https://skillicons.dev)

## 🔤 Fonts

| Font | Type | Implementation |
| ------------ | ---------- | ----------------------------------- |
| Exo 2 | Sans-serif | `@import` from Google Fonts |
| Dirtyline 36 | Display | Local WOFF2 file in `/public/fonts` |

## ⚙️ Installation

Follow these steps to set up and run the project on your local machine:

1. **Clone the Repository**

```bash
git clone https://github.com/jane-does-coding/lumea
```

2. **Install Dependencies**

```bash
npm i
```

3. **Run Locally**
```bash
npm run dev
```

## 🎯 Purpose

Environmental Impact:
Democratizes access to complex carbon calculations through an intuitive interface.

Behavioral Change:
Visual data presentation encourages users to adopt more sustainable lifestyle choices.

## 🤝 Contributing

Fork the repository

Create your feature branch (git checkout -b feature/amazing-feature)

Commit changes (git commit -m 'Add amazing feature')

Push to branch (git push origin feature/amazing-feature)

Open a Pull Request