Skip to content

SamadritaBhattacharya/Flowfix

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fluxion 💧

Fluxion is an online platform designed to streamline drainage complaints, providing users with a convenient way to report and address drainage issues in their communities. Our platform is built with efficiency and user-friendliness in mind, utilizing Vite for the frontend, MongoDB for the database, and Node.js for the backend.

Features 🚀

  • User-friendly Interface: Fluxion offers an intuitive interface that allows users to easily submit drainage complaints and track their progress.
  • Efficient Reporting: With Fluxion, users can quickly report drainage issues by providing necessary details such as location, description, and images.
  • Real-time Updates: Users can stay informed about the status of their complaints through real-time updates and notifications.
  • Data Management: Our platform efficiently manages complaint data, ensuring seamless communication between users and administrators.
  • Responsive Design: Fluxion is designed to be responsive, offering a consistent experience across various devices and screen sizes.

Technologies Used 💻

  • Frontend: Vite, Tailwind css, Leaflet js
  • Backend: Node.js
  • Database: MongoDB

Installation 🛠️

To install Fluxion locally, follow these steps:

  1. Clone the repository: git clone https://github.com/SamadritaBhattacharya/fluxion.git
  2. Navigate to the project directory: cd fluxion
  3. Install dependencies:
    • Frontend: cd frontend && npm install
    • Backend: cd backend && npm install
  4. Set up MongoDB database (you'll need to have MongoDB installed and running locally).
  5. Configure environment variables as needed.
  6. Start the frontend and backend servers:
    • Frontend: npm run dev
    • Backend: npm run dev

Contributing 🤝

We welcome contributions from the community to help improve Fluxion. If you'd like to contribute, please follow these guidelines:

  1. Fork the repository.
  2. Create your feature branch: git checkout -b feature/YourFeature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin feature/YourFeature
  5. Submit a pull request.

License 📄

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

Contact 📧

For any inquiries or support, feel free to contact us at [email protected] and [email protected]

About

No description, website, or topics provided.

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •