| To create a README file for your Streamlit application, you can provide a brief overview of the application, its features, and how to run it. Here's an example README file for your application: | |
| --- | |
| # Insta's EYE - Face Recognition and Person Management | |
| Insta's EYE is a Streamlit application that allows users to manage a database of people along with their Instagram handles and perform face recognition on uploaded images. The application integrates with Firebase for authentication and database management. | |
| ## Features | |
| - **User Authentication:** Users can sign up and log in to manage their set of images and profiles. | |
| - **Add Person:** Users can add a person to the database along with their name, image, and Instagram handle. | |
| - **Recognize Face:** Users can upload an image and the application will recognize the person in the image, if present in the database. | |
| - **Recognize Face (Optimal):** Users can upload an image and the application will find the best match in the database based on the similarity of facial features. | |
| - **Delete Person:** Users can delete a person from the database. | |
| ## Getting Started | |
| 1. Clone the repository: | |
| ```sh | |
| git clone https://github.com/your_username/instas-eye.git | |
| ``` | |
| 2. Install the required dependencies: | |
| ```sh | |
| pip install -r requirements.txt | |
| ``` | |
| 3. Run the Streamlit application: | |
| ```sh | |
| streamlit run app.py | |
| ``` | |
| 4. Access the application in your web browser at `http://localhost:8501`. | |
| ## Dependencies | |
| - Streamlit | |
| - Firebase Admin SDK | |
| - Face Recognition | |
| - dlib | |
| - OpenCV | |
| - PIL | |
| ## License | |
| This project is licensed under the MIT License - see the `LICENSE` file for details. | |
| --- | |
| You can customize this README file further based on your specific application details and requirements. |