Skip to content

Latest commit

 

History

History
109 lines (66 loc) · 5.44 KB

README.md

File metadata and controls

109 lines (66 loc) · 5.44 KB
Raw

Anzone 🚨

Anzone is an AI/ML-powered women’s safety application designed to enhance your safety with real-time alerts and critical support. The app notifies you when you're in areas with high crime rates, offers an SOS feature for emergencies, and provides advice on how to handle potentially dangerous situations.

Demo and Prototype 🎥

We are excited to showcase Anzone through our live demo and interactive prototype. This is your opportunity to explore the key features of the app, experience the user-friendly interface, and see how real-time alerts and the AI-powered chatbot can enhance your safety.

  • View the Chatbot Demo: Navigate through our web platform and see how Anzone provides dynamic safety updates, practical advice, and more.
  • Prototype Link: Check out the Android application design prototype built with Figma.

Explore the demo to witness how Anzone makes safety accessible, intuitive, and powerful!

Objective 🎯

Anzone aims to empower women by leveraging advanced technology to create a safer environment. The app uses AI and machine learning to analyze real-time data, sending alerts to keep you informed and safe. In addition to emergency SOS features, Anzone guides you with practical advice when you need it most, ensuring you're prepared and protected wherever you go.

⚡ How to run the website? 🕹️

To run this project locally, follow these steps:

  1. Fork the repository.

  2. Clone the repository to your local computer: git clone https://github.com/your-username/Codess-Hackathon

  3. Open the project folder in your preferred code editor, and run the following command in the terminal and make sure your are in the correct directory :

cd Codess-Hackathon
npm install 
nodemon app.js

Tech Stack 🛠️

  1. Website:
  • EJS (Embedded JavaScript Templates): The website’s interface is rendered using EJS, which allows dynamic content to be injected into HTML templates. This makes the site interactive and user-friendly.

  1. AI Chatbot:

    • OpenAI API: The chatbot leverages OpenAI’s natural language processing capabilities to provide real-time assistance and safety advice to users.
    • API Integration: The chatbot is integrated using a custom API to connect the user with the AI for quick, relevant responses.

  2. Design of the Android Application:

    • Figma: The application’s design prototype was created in Figma.

How to Contribute 🤝

We welcome and value all types of contributions to Anzone! Whether you’re a developer, designer, or just passionate about women’s safety, there are several ways you can make a difference:

1. Report Issues 🐞

  • Find a Bug? If you encounter any bugs or issues while using Anzone, please let us know by creating a new issue following the bug report template. Provide as much detail as possible to help us address it effectively.

2. Suggest Features 💡

  • Have an Idea? We’re always looking to improve! If you have suggestions for new features or enhancements, please open a new issue, you could follow a template or write your own issue.

3. Participate in Discussions 💬

  • Join the Conversation: Engage with existing discussions in our discussions by commenting your suggestions in issues marked with discussion. Share your thoughts, provide feedback, or offer solutions to ongoing conversations.

4. Submit Pull Requests 🛠️

  • Code Contributions: If you’d like to contribute code, follow these steps:
    1. Fork the Repository: Click the Fork button at the top right of this repository to create your own copy.
    2. Clone Your Fork: Clone your fork to your local machine using: 
      git clone https://github.com/your-username/Anzone.git
    3. Create a New Branch: Create a branch for your changes: 
      git checkout -b your-branch-name
    4. Make Your Changes: Implement your changes or fixes.
    5. Commit and Push: Add, commit, and push your changes in your branch: 
      git add .
git commit -m "Add a descriptive commit message"
git push origin your-branch-name
    6. Open a Pull Request: Go to the original repository, click on the Pull Requests tab, and submit your pull request.

Every Contribution Matters!

We appreciate every effort, no matter how big or small. Your involvement helps us make Anzone better and more effective. Thank you for being a part of our community!

Future Scope 🚀

  • Chatbot Integration: The website will soon feature an integrated chatbot to provide real-time assistance and support.

  • Android Application: After the chatbot integration, Anzone will be developed into an Android application, making it accessible anytime and anywhere.

  • Voice-Activated Chatbot: Future iterations will include voice activation, allowing hands-free interaction with the chatbot for increased accessibility, especially during emergencies.

  • Enhanced AI & Data Analytics: Improving AI capabilities to provide more personalized and accurate responses based on user behavior and advanced data analytics. Leveraging machine learning to better predict high-risk areas and offer preventative safety measures.