Skip to content

RubyNguyen07/Hack4good24

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Green Action Website

Welcome to Green Action - your platform for environmental activism and awareness! This web application is designed to empower individuals and communities to take action towards a greener and more sustainable world.

About

Green Action is a project developed for Hack4Good24, aimed at enhancing engagement and measuring the environmental impact of volunteer activities. By integrating game mechanics, the platform motivates users through the point system, rewards, and achievements.

Tech Stack

  • User Authentication: Powered by Clerk, Green Action ensures secure user authentication and authorization for seamless access to the platform's features.
  • Express.js & Node.js Backend: The backend of Green Action is built using Express.js and Node.js, providing a robust and scalable server-side architecture.
  • React Frontend: The frontend is developed with React, offering a dynamic and interactive user experience.
  • Shadcn Integration: Shadcn is integrated to enhance the platform's social features.
  • Supabase Database: Supabase is utilized as the database solution, offering real-time data synchronization, scalability, and security.
  • Tailwind CSS Styling: Tailwind CSS is used for styling, allowing for rapid development and customization with utility-first CSS classes.
  • Vercel Deployment: Green Action is deployed on Vercel, ensuring fast and reliable hosting with automatic deployments from Git.
  • Vite Build Tool: Vite is used as the build tool for efficient development and optimized production builds.

For more in-depth information on our backend site, simply look through the documentation at be/README.md

Getting Started

To get started with Green Action, simply visit https://hack4good24-an59.vercel.app/ in your web browser. From there, you can sign up for an account, explore the platform's features, and take action for a greener planet!

Set up instructions

  1. Clone git repository.
  2. Create and define .env file in the root directory of the project.
  3. Install dependencies
npm install 
  1. Run the server on localhost:3000
npm run start 

Contributing

We welcome contributions from the community to improve Green Action and make it even more impactful. Whether it's fixing bugs, adding new features, or suggesting improvements, every contribution helps advance our mission of environmental activism and awareness. To contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/improvement)
  3. Make your changes and commit them (git commit -am 'Add new feature')
  4. Push to the branch (git push origin feature/improvement)
  5. Create a new Pull Request

Feedback

We value your feedback! If you have any suggestions, ideas, or issues to report, please don't hesitate to reach out to us. You can contact us by opening an issue on GitHub.

Acknowledgments

  • Thanks to the organizers of Hack4Good24 for providing the opportunity to develop this project.
  • Special thanks to all contributors and supporters who have helped make Green Action a reality.