Skip to content

Latest commit

 

History

History
178 lines (133 loc) · 6.6 KB

README.md

File metadata and controls

178 lines (133 loc) · 6.6 KB

ACES TechFest Hackathon V7 - Reactango Coders

Overview

This project aims to provide a seamless and interactive platform built using React.js. It features clean UI/UX and efficient performance optimized for both functionality and user experience.

The project implements core functionalities such as:

  • Modern UI components
  • State management
  • Interactive map integration
  • api handling
  • Routing and navigation

Features

  • 🚀 Landing Page: A beautifully crafted landing page with smooth navigation.
  • 🗺 Dustbin Map: Interactive map showcasing mock dustbin locations using Leaflet.
  • 🔐 Authentication: Login and Signup forms for user access.
  • 📄 Pages:
    • Homepage
    • Contact Us
    • About Us
    • User Dashboard
  • 🎉 Optimized User Experience: Dynamic components and responsive layouts using Tailwind CSS.

Tech Stack

The project is powered by the following technologies:

Frontend

  • React.js: A JavaScript library for building user interfaces.
  • React Router: For handling routing and navigation.
  • Django: A powerful and fast python web framework
  • Leaflet.js: Interactive maps for displaying geolocation data.
  • Tailwind CSS: Utility-first CSS framework for styling.
  • Toastify: For notifications and user feedback.

Getting Started

Follow these steps to clone and run the project locally.

Prerequisites

Make sure you have the following installed on your machine:

  • Node.js (>= 14.x)
  • npm (Node Package Manager) or yarn
  • Git

Installation

  1. Clone the repository: bash git clone https://github.com/aces-erc/aces_techfest_hackathon_v7_reactango_coders.git cd aces_techfest_hackathon_v7_reactango_coders

  2. Install dependencies: Using npm: bash npm install

    OR using yarn: bash yarn install

Run the Project

To start the development server: bash npm start

OR using yarn: bash yarn start

The project will run on http://localhost:3000.

Project Structure

plaintext src/ ├── assets/ # Static assets like images ├── auth/ # Login and Signup components ├── components/ # Reusable components (e.g., Modal, Dashboard, etc.) ├── Layout/ # Layout wrapper for pages ├── pages/ # Main pages (LandingPage, DustbinMap, etc.) ├── protected/ # Protected route utilities ├── App.js # Main app component ├── index.js # Entry point for React app └── ...

Contributing

Contributions are welcome! Follow these steps:

  1. Fork the repository.

  2. Create a new branch: bash git checkout -b feature-branch

  3. Commit your changes: bash git commit -m "Add new feature"

  4. Push to your branch: bash git push origin feature-branch

  5. Open a Pull Request.

License

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

Acknowledgements

  • React.js for providing the core library.
  • Leaflet.js for its incredible mapping functionality.
  • Tailwind CSS for efficient and responsive styling.

Special thanks to the ACES TechFest organizers and the entire team who contributed to this project!

Made with ❤ by the Reactango Coders Team