/booggle_deploy

Primary LanguageCSS

Booggle Finance

Booggle Finance is a full-stack web application that leverages data scraping techniques to gather historic pricing data for whiskey bottles. The application provides users with valuable insights and analysis based on the collected data. The website can be accessed at booggle-finance.com.

Table of Contents

Overview

Booggle Finance is designed to assist whiskey enthusiasts, collectors, and investors in making informed decisions based on historic pricing trends. By scraping data from various sources, the application accumulates a vast amount of whiskey bottle pricing data. Users can access the website and utilize the provided features to gain insights into price fluctuations, identify potential investment opportunities, and track the value of their whiskey collections.

Features

  1. Data Scraping: Booggle Finance employs web scraping techniques to collect historic pricing data from multiple sources, ensuring a comprehensive database for analysis.

  2. Data Visualization: The application provides intuitive and interactive visualizations, including charts, graphs, and tables, to present pricing trends and patterns in a user-friendly manner.

  3. Price Analysis: Users can perform detailed analysis on whiskey bottle prices based on various parameters, such as brand, age, region, and rarity, to identify valuable bottles and potential investment opportunities.

  4. Portfolio Tracking: The application allows users to create and manage their whiskey collections, track the value of their portfolios over time, and receive notifications for significant price changes.

  5. User Profiles: Users can create personal profiles, customize their preferences, and receive personalized recommendations based on their collection and interests.

  6. Search and Filter: The website provides robust search and filter functionalities to easily navigate and explore the extensive whiskey bottle database.

  7. User Reviews: Users can contribute to the community by leaving reviews and ratings for whiskey bottles, sharing their experiences, and helping others make informed decisions.

    • Create a .env file based on the provided .env.example file.
    • Replace the placeholder values with the required configuration details, such as database credentials, API keys, etc.

Usage

Upon accessing the Booggle Finance website, users can perform the following actions:

  1. Sign Up / Log In: Create a new account or log in with existing credentials to access personalized features.

  2. Explore Pricing Data: Browse through the extensive whiskey bottle database, filter and search based on specific criteria, and view detailed pricing information.

  3. Analyze Prices: Utilize the provided charts, graphs, and analysis tools to examine pricing trends and patterns based on different parameters.

  4. Manage Collections: Create a personal whiskey collection, add bottles to it, and track the value of your collection over time.

  5. Contribute Reviews: Share your experiences and contribute to the community by leaving reviews and ratings for whiskey bottles.

  6. Receive Notifications: Opt-in to receive notifications for significant price changes or updates related to your collection and favorite bottles.

  7. Customize Preferences: Personalize your profile settings, including notification preferences, privacy options, and dashboard layout.

Technologies

The following technologies are used in the development of Booggle Finance:

  • Frontend: HTML, CSS, JavaScript
  • Backend: Python, Django
  • Data Scraping: Python, Beautiful Soup, Selenium
  • Data Visualization: Matplotlib, Chart.js
  • Authentication: JSON Web Tokens (JWT)
  • API Integration: Fetch API, Axios
  • Database: Postgres
  • Deployment: AWS

Contributing

Contributions to Booggle Finance are welcome! If you encounter any issues, discover bugs, or have suggestions for improvements, please open an issue in the GitHub repository. To contribute code changes, follow these steps:

  1. Fork the repository.

  2. Create a new branch:

    git checkout -b feature/your-feature-name

  3. Make the necessary changes and commit them:

    git commit -m "Add your commit message"

  4. Push the changes to your forked repository:

    git push origin feature/your-feature-name

  5. Open a pull request on the main repository.

Please ensure that your contributions adhere to the existing code style, include appropriate tests, and provide a clear description of the changes you made.

License

This project is licensed under the MIT License.