stink-po / favorite_cafe

favoritecafe.ir

Welcome to favoritecafe.ir, a dynamic website built with Python Flask, Bootstrap CSS, and JavaScript. This website allows users to discover and review cafes from around the world. With the help of Pexels API, we showcase captivating pictures on every page, creating an immersive experience for our users.

Key Features

• Multiple Databases: We utilize both MySQL and MongoDB databases to store and manage our data effectively.
• User Roles: There are two types of users on our platform, each with their own set of abilities and permissions.
• Cafe Creation: Users can create new cafes in any city worldwide, providing valuable information to fellow coffee enthusiasts.
• Reviews and Ratings: Users have the ability to leave reviews and rate cafes, enabling others to make informed decisions.
• User Interaction: Users can follow their favorite cafes, upload their own profile pictures, and stay connected within the community.
• Email Verification: We have implemented an email confirmation mechanism to ensure the authenticity of user accounts.
• API Integration: We provide an API key creation feature and offer a comprehensive RESTful API with detailed documentation.
• Account Management: Users can update their email address, change their password, and utilize a secure password recovery mechanism.
• Fresh News Updates: Our platform fetches daily news about coffee and cafes from a reliable news API, keeping users informed and engaged.

Installation and Setup

To set up the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/Stink-Po/favorite_cafe.git
   

Install the required dependencies:

   pip install -r requirements.txt

Configure your environment variables for database connections and API keys.

Launch the application:

   python app.py

Access the website via your browser at http://localhost:5000.

API Documentation We offer a RESTful API that allows developers to access and interact with our platform's data. For detailed documentation and examples, please refer to our API Documentation.

Contributing We welcome contributions from the community to enhance the functionality and features of favoritecafe.ir. If you'd like to contribute, please follow our Contribution Guidelines.

Contact If you have any questions, suggestions, or feedback, feel free to reach out to our team at [email protected].

Thank you for choosing favoritecafe.ir. Enjoy discovering your favorite cafes around the world!