Skip to content

KeshavCh0udhary/greensteps-habit-tracker

Repository files navigation

GreenSteps Habit Tracker 🌱

A modern, eco-friendly habit tracking application that helps users build sustainable habits while contributing to a greener planet.

🌟 Features

  • Habit Tracking: Log and track your daily eco-friendly habits
  • Points System: Earn points for sustainable actions
  • Leaderboard: Compete with other users and see who's making the biggest impact
  • Badges: Unlock achievements for consistent eco-friendly behavior
  • Real-time Updates: See your progress and impact immediately
  • Responsive Design: Works seamlessly on desktop and mobile devices

🚀 Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • npm (v9 or higher)
  • Git

Installation

  1. Clone the repository:

    git clone https://github.com/KeshavCh0udhary/greensteps-habit-tracker.git
    cd greensteps-habit-tracker
  2. Install dependencies:

    npm install
  3. Create a .env file in the root directory with your Supabase credentials:

    VITE_SUPABASE_URL=your_supabase_url
    VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
    
  4. Start the development server:

    npm run dev
  5. Open http://localhost:5173 in your browser

🛠️ Built With

  • Vite - Next Generation Frontend Tooling
  • React - A JavaScript library for building user interfaces
  • TypeScript - JavaScript with syntax for types
  • Tailwind CSS - A utility-first CSS framework
  • shadcn/ui - Beautifully designed components
  • Supabase - Open source Firebase alternative
  • Framer Motion - Animation library for React

📦 Project Structure

greensteps-habit-tracker/
├── src/
│   ├── components/     # Reusable UI components
│   ├── pages/         # Page components
│   ├── lib/           # Utility functions and hooks
│   ├── types/         # TypeScript type definitions
│   └── App.tsx        # Main application component
├── public/            # Static assets
└── package.json       # Project dependencies

🚀 Deployment

The project is deployed on Vercel. To deploy your own version:

  1. Fork this repository
  2. Create a new project on Vercel
  3. Import your forked repository
  4. Add your environment variables
  5. Deploy!

🤝 Contributing

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

  1. Fork the project
  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.

🙏 Acknowledgments

  • Thanks to all contributors who have helped shape this project
  • Special thanks to the open-source community for their amazing tools and libraries

📞 Contact

Keshav Chaudhary - @KeshavCh0udhary

Project Link: https://github.com/KeshavCh0udhary/greensteps-habit-tracker

🌱 Live Demo

Check out the live application at: https://greensteps-habit-tracker.vercel.app

About

A modern, eco-friendly habit tracking application that helps users build sustainable habits while contributing to a greener planet.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages