Skip to content

CarboQuiz is an interactive web application designed to help users understand their carbon footprint through an engaging quiz experience.

Notifications You must be signed in to change notification settings

2105789/CarboQuiz

Repository files navigation

🌿 CarboQuiz: Measure Your Carbon Footprint 🌎

CarboQuiz Home Page

About CarboQuiz

CarboQuiz is an interactive web application designed to help users understand their carbon footprint through an engaging quiz experience. By answering questions about daily habits and lifestyle choices, users receive personalized feedback on their environmental impact and practical suggestions for improvement.

✨ Features

📊 Interactive Carbon Footprint Quiz

Answer questions about your daily habits and receive immediate feedback on how your choices affect the environment.

Quiz Interface

🌱 Detailed Impact Analysis

After each answer, see a detailed breakdown of the environmental impact of your choices with suggestions for improvement.

Impact Analysis

📈 Comprehensive Results

Get a complete analysis of your carbon footprint with visualizations and comparisons to help understand your environmental impact.

Results Page

🔍 Detailed Results Breakdown

Review each of your answers with specific feedback and improvement suggestions.

Detailed Results

🏆 Leaderboard

Compare your results with other users and see where you stand in terms of environmental consciousness.

Leaderboard

📧 Email Results

Share your results via email to keep track of your progress or challenge friends to beat your score.

Email Results

🛠️ Technologies Used

  • Next.js: React framework for server-rendered applications
  • React: Frontend UI library
  • TypeScript: Type-safe JavaScript
  • Tailwind CSS: Utility-first CSS framework for styling
  • Firebase: Backend database and authentication
  • Recharts: Charting library for visualizations
  • Framer Motion: Animation library for smooth transitions
  • React PDF Renderer: PDF generation for sharable results
  • Nodemailer: Email functionality

🚀 Getting Started

Prerequisites

  • Node.js (v14 or newer)
  • npm or Bun package manager

Installation

  1. Clone the repository:

    git clone https://github.com/2105789/CarboQuiz.git
    cd carboquiz
  2. Install dependencies:

    npm install
    # or
    bun install
  3. Start the development server:

    npm run dev
    # or
    bun dev
  4. Open your browser and navigate to http://localhost:3000

📝 Usage

  1. Start the quiz and enter your name and email
  2. Answer each question honestly about your daily habits
  3. Review the impact of each choice
  4. Get your final results and recommendations
  5. Share your results or try again to improve your score

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgements

  • All contributors who have helped make this project better
  • The environmental organizations providing data on carbon footprints
  • The open-source community for providing amazing tools and libraries

Made with 💚 for a greener planet

About

CarboQuiz is an interactive web application designed to help users understand their carbon footprint through an engaging quiz experience.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages