lost-and-found-app

• 📝️ About
  • 🛠️ Built With
• 🚀 Getting Started
  • 📋 Prerequisites
  • 📥 Installation
• 🗺️ Roadmap
• 🤝 Contributing
• 📄 License

📝 About

The Lost and Found Application is designed to help users report and find lost items. The application features user authentication, profile management, an interactive map for locating items, and tools for admins to moderate the platform. Users can post details about lost items and search for found items.

🛠 Built With

🚀 Getting Started

To set up the project locally follow these steps:

📋 Prerequisites

📥 Installation

1. Clone the repository:

   git clone https://github.com/sergebyte/lost-and-found-app.git
   

2. Navigate to the project directory:

   cd lost-and-found-app
   

3. Install the NPM packages:

   npm install
   

4. Start the components using Docker

   docker compose up
   

🗺️ Roadmap

• Authentication
• User profile management
• Interactive map with a switch between lost and found items
• Button and page to add lost or found objects
• Detailed page for each added item
• List with various filters, defaulting to show the closest reported lost item (switchable to found)
• Admin control with moderation tools
  • User banning
  • Content review
• Messaging feature for user communication
• Push notifications for updates
• Multi-language support
• Offline functionality

🤝 Contributing

We encourage and appreciate all contributions to this project. Whether you are fixing bugs, adding new features, improving documentation, or proposing enhancements, your contributions are valuable to us. Thank you for your contribution, if you enjoy this project, don't forget to star it.

1. Fork the repository.
2. Create a new feature branch: (git checkout -b feature-branch)
3. Commit the changes: (git commit -m 'Add new feature')
4. Push to the branch: (git push origin feature-branch)
5. Open a pull request.

License

The Lost and Found Application source code is made available under the GNU Affero General Public license. Some of the dependencies might be licensed differently. See LICENSE for more information.