Wine Cellar

Wine Cellar is a self-hosted wine management app built with Django, designed for wine enthusiasts who want to keep track of the wines they've tried, store tasting notes, rate wines, and manage their wine inventory. Whether you're a casual wine drinker or a connoisseur with a growing collection, this app helps you organize and enjoy your wine journey. Additionally, you can add food pairings to wines for the perfect dining experience.

Features

• Wine Tracking: Record wines you've tasted and whether you liked or disliked them.
• Inventory Management: Keep track of how many bottles you have in stock.
• Tasting Notes: Add detailed notes to remember the aroma, flavor, and overall experience.
• Wine Ratings: Rate each wine on a scale to keep track of your preferences.
• Food Pairings: Add suggested food pairings to wines to complement your tastings.
• Self-hosted: Complete control over your data, running on your own server.

---

Table of Contents

• Prerequisites
• Getting Started
  • Clone the Repository
  • Install Dependencies
  • Run the Development Server
  • Watch for Changes
  • Create a User
  • Load Fixtures
• Directory Structure
• Running Tests
• Additional Information

---

Prerequisites

Before you begin, ensure your machine has the following installed:

• Python 3.x (for the backend)
• Node.js (v14.x or higher recommended, for the frontend)
• npm (comes with Node.js)

---

Getting Started

Follow these steps to set up and run the Wine Cellar app:

1. Clone the Repository

Clone the repository to your local machine and navigate into the project folder:

git clone https://github.com/yourusername/wine-cellar.git
cd wine-cellar

2. Install Dependencies

This command will set up a Python virtual environment, install Python dependencies, install npm packages, build the frontend, and apply database migrations:

make install

3. Run the Development Server

To start the Django development server, use:

make server

By default, the server will run at http://127.0.0.1:8003/.

4. Watch for Changes

To automatically rebuild the frontend and restart the backend server on file changes, run:

make watch

5. Create a User

Create an admin user for managing the app by running the following:

source venv/bin/activate
python manage.py createsuperuser

6. Load Fixtures (Optional)

If you want to load some initial data (e.g., sample wines, categories), run:

make fixtures

---

Directory Structure

Here's an overview of the project structure:

• wine_cellar/: Main application code (Django app for wines, inventory, ratings, etc.).
• tests/: Test cases for the application (both backend and frontend).
• node_modules/: Directory for npm packages (installed dependencies for the frontend).
• venv/: Python virtual environment (isolated dependencies for the backend).
• Makefile: A file containing predefined commands for setup and running the app.

---

Running Tests

To run the full test suite (both Django and frontend tests), use:

make test

You can also run Django backend tests directly using:

python manage.py test

---

Additional Information

For more details on how to use specific commands or customize the setup, refer to the Makefile in the root directory of the repository. You can also check the official Django and Node.js documentation for more information on extending or modifying the application.