From 7f0a1ed1517fc832b9f76909c5a790836d2a8857 Mon Sep 17 00:00:00 2001 From: Tyler Lightwood Date: Tue, 30 Jan 2024 22:08:16 +0000 Subject: [PATCH] Added requirements.txt and updated README --- .vscode/extensions.json | 5 ++ README.md | 74 ++++++++++++++++++++++++++- requirements.txt | 108 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 186 insertions(+), 1 deletion(-) create mode 100644 .vscode/extensions.json create mode 100644 requirements.txt diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..174a5cc --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,5 @@ +{ + "recommendations": [ + "github.copilot" + ] +} \ No newline at end of file diff --git a/README.md b/README.md index ceb858b..949d25c 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,19 @@ Welcome to FurEver Friends, your ultimate destination for managing animals in th FurEver Friends is a heartwarming Animal Shelter Management System designed to simplify the process of caring for and finding homes for shelter animals. Our system provides a seamless platform for shelter administrators to manage animals, update their adoption statuses, and maintain records efficiently. +# Table of Contents + +- [FurEver Friends 🐾](#-furever-friends-) +- [Features 🌟](#features-) +- [Installation 🚀](#installation-) +- [Setting Up MongoDB 🍃](#setting-up-mongodb-) +- [First-Time Login ⚙️](#first-time-login-) +- [System Requirements 💻](#system-requirements-) +- [Future Plans 🚀](#future-plans-) +- [Contributing 💖](#contributing-) +- [License 📝](#license-) + + ## Features 🌟 - **Secure Login**: Administrators can log in securely with the username `ADMIN` and password `ADMIN` on first start to access the system. @@ -24,19 +37,77 @@ FurEver Friends is a heartwarming Animal Shelter Management System designed to s ``` cd FurEver_Friends ``` + +3. **Install the required dependancies** + ''' + pip install -r requirements.txt + ''' -3. **Run the Application**: +4. **Run the Application**: ``` python FurEver_Friends.py ``` +## Setting Up MongoDB 🍃 + +To use FurEver Friends, you need to have a MongoDB database. Here's how you can set it up: + +1. **Create a MongoDB Account**: + + - Visit the [MongoDB website](https://www.mongodb.com/) and create an account. + +2. **Create a New Project**: + + - After logging in, create a new project. + - Give your project a name and create it. + +3. **Create a New Cluster**: + + - In your project, create a new cluster. + - Choose a provider and a region. + - Choose a cluster tier. The free tier, M0 Sandbox, is sufficient for this project. + - Give your cluster a name and create it. + +4. **Create a Database User**: + + - In the Database Access tab, add a new database user. + - Choose a username and a password. Remember these credentials as you'll need them to connect to your database. + +5. **Get Your MongoDB URI**: + + - In your cluster, click on the CONNECT button. + - Choose "Connect your application". + - Copy the provided connection string (MongoDB URI). + +Remember to replace `` in the MongoDB URI with the password of the database user you created. + +You can now use this MongoDB URI to connect to your MongoDB database from FurEver Friends! Everything else is automatically set up so you don't need to do anything past that point. + ## First-Time Login ⚙️ - To access the system for the first time, use the following credentials: - Username: `ADMIN` - Password: `ADMIN` +## System Requirements 💻 + +FurEver Friends is developed using Python. To run this application from the source code, you need: + +- Python 3.12 or higher +- pip (Python Package Installer) + +## Future Plans 🚀 + +We're constantly working to improve FurEver Friends and add new features. Here are some of the updates we're planning: + +- Animal medical records +- User schedule for hours and events +- Notifications in app +- Website intergration + +Stay tuned for these exciting updates and more! + ## Contributing 💖 We welcome contributions from compassionate individuals who share our mission! If you'd like to contribute to FurEver Friends, follow these steps: @@ -47,6 +118,7 @@ We welcome contributions from compassionate individuals who share our mission! I 5. Push to the branch (`git push origin feature-name`). 6. Create a new Pull Request filled with love and dedication! + ## License 📝 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..8c7755f --- /dev/null +++ b/requirements.txt @@ -0,0 +1,108 @@ +altgraph==0.17.4 +annotated-types==0.6.0 +anyio==4.2.0 +asttokens==2.4.1 +beautifulsoup4==4.12.2 +blinker==1.7.0 +bottle==0.12.25 +bottle-websocket==0.2.9 +browser-cookie3==0.19.1 +cachetools==5.3.2 +certifi==2023.7.22 +cffi==1.16.0 +charset-normalizer==3.3.2 +click==8.1.7 +colorama==0.4.6 +colorzero==2.0 +comtypes==1.2.0 +cryptography==42.0.2 +customtkinter==5.2.2 +darkdetect==0.8.0 +decorator==5.1.1 +deep-translator==1.11.4 +distro==1.9.0 +dlib==19.24.2 +dnspython==2.5.0 +Eel==0.16.0 +emoji==2.9.0 +executing==2.0.1 +Flask==3.0.0 +Flask-Cors==4.0.0 +future==0.18.3 +gevent==23.9.1 +gevent-websocket==0.10.1 +google-api-core==2.15.0 +google-auth==2.26.0 +google-cloud-core==2.4.1 +google-cloud-translate==3.13.0 +googleapis-common-protos==1.62.0 +gpiozero==2.0 +greenlet==3.0.3 +grpcio==1.60.0 +grpcio-status==1.60.0 +h11==0.14.0 +h2==4.1.0 +hpack==4.0.0 +httpcore==1.0.2 +httpx==0.26.0 +hyperframe==6.0.1 +idna==3.6 +ipython==8.17.2 +itsdangerous==2.1.2 +jedi==0.19.1 +Jinja2==3.1.2 +langdetect==1.0.9 +lz4==4.3.3 +MarkupSafe==2.1.3 +matplotlib-inline==0.1.6 +numpy==1.26.2 +openai==1.6.1 +opencv-python==4.9.0.80 +packaging==23.2 +parso==0.8.3 +pefile==2023.2.7 +pillow==10.2.0 +prompt-toolkit==3.0.39 +proto-plus==1.23.0 +protobuf==4.25.1 +psutil==5.9.7 +pure-eval==0.2.2 +pyasn1==0.5.1 +pyasn1-modules==0.3.0 +PyAudio==0.2.14 +pycparser==2.21 +pycryptodomex==3.19.1 +pydantic==2.5.3 +pydantic_core==2.14.6 +pydub==0.25.1 +pygame==2.5.2 +Pygments==2.16.1 +pyinstaller==6.3.0 +pyinstaller-hooks-contrib==2023.11 +pymongo==4.6.1 +pyparsing==3.1.1 +pypiwin32==223 +pyttsx3==2.90 +pywin32==306 +pywin32-ctypes==0.2.2 +requests==2.31.0 +rsa==4.9 +setuptools==69.0.3 +six==1.16.0 +sniffio==1.3.0 +sounddevice==0.4.6 +soupsieve==2.5 +SpeechRecognition==3.10.1 +stack-data==0.6.3 +tqdm==4.66.1 +traitlets==5.13.0 +transforms==0.2.1 +typing_extensions==4.9.0 +urllib3==2.1.0 +waitress==2.1.2 +wcwidth==0.2.9 +Werkzeug==3.0.1 +wheel==0.42.0 +whichcraft==0.6.1 +zope.event==5.0 +zope.interface==6.1