How vlyon07/beers4all works
Project type and purpose
• BeerAll is a full-stack web application for browsing, reviewing, and favoriting breweries worldwide.
• Frontend: Vue 3 + Vite + Tailwind (PWA).
• Backend: Node.js + Express + Sequelize (PostgreSQL).
• Persistence: Supabase-hosted Postgres.
• Deploy: Render (frontend & API), Supabase (DB).
• Integrates with the OpenBreweryDB external API for initial brewery data.
File structure
Top-level:
• backend/
– backend.js (Express app entry)
– config/ (DB & JWT secrets)
– controllers/ (authController, userController)
– middleware/ (authMiddleware)
– models/ (User, Review, Favorite + index)
– routes/ (auth.js, user.js)
– db.js (Sequelize init)
– migrations/, seeders/ (DB versioning & demo data)
• frontend/
– src/
• main.js, App.vue
• components/ (BreweryCard, Navbar, useUser composable)
• router/ (Vue Router)
• views/ (Landing, Login, etc.)
• assets/ (CSS, images)
– Vite/Tailwind/Vuetify configs
– .env.* for dev/prod endpoints & keys
README for architectural insights
• Confirms separation of concerns: Vue SPA calls Express REST API.
• Auth uses JWT_SECRET, protected routes via authMiddleware.
• DB migrations/seeders maintain schema.
• External dependencies: OpenBreweryDB, Supabase, Render.
a. Main components:
1. Client Browser (Vue SPA)
2. Static Asset Host (Render CDN)
3. Backend Service (Node/Express API on Render)
4. Database (PostgreSQL on Supabase)
5. External API (openbrewerydb.org)
b. Relationships & interactions:
• Browser ⇄ Static Host: serves index.html, JS, CSS.
• Browser → Backend API: REST calls (auth, users, reviews, favorites).
• Backend → Database: Sequelize ORM queries.
• Backend → External API: initial brewery data fetch (at dev or build time).
c. Architectural patterns:
• MVC-style layering in backend (routes → controllers → models).
• JWT-based auth middleware.
• Vue component architecture with composables (useUser), router.
d. Key technologies:
• Node.js, Express, Sequelize, PostgreSQL
• Vue 3, Vite, Tailwind CSS, Vuetify, Vue Router
• JWT, dotenv for config
• Render (hosting), Supabase (DB), OpenBreweryDB (3rd-party data)
Detail to capture
• Middleware intercepting requests before controllers.
• Migrations/seeders as part of the deployment workflow.