🚀 Final Project Boilerplate

🏠 Root

The root of the project is set up with automatic pre-commit autolinting for JavaScript and Python using Prettier 🖋️ and Ruff 🐍.

🌐 Web (/web)

⚛️ React Template

The front-end uses a React template from Vite. Scaffolding reference: Vite Docs

📦 Necessary Packages for FE

Utilities

• lodash: Functional utilities GitHub 🔧
• react-router: Routing library Docs 🛣️

Data Fetching

• axios: HTTP client Docs ⚡
• react-query: Server-state management Docs 📡

Styling & Components

• Material-UI: Modern UI components Docs 🎨
• React Bootstrap: Bootstrap components Docs 🅱️
• Reactstrap: Bootstrap 4 components Docs 🖼️
• Ant Design: Enterprise UI Docs 🏢
• Tailwind CSS: Utility-first CSS Docs 🌬️

🖥️ API (/api)

🐍 Pipenv

Back-end uses Pipenv for dependency management. Installation reference: Pipenv Docs

📦 Necessary Packages for BE

• Flask: Web framework Docs 🌐
• Flask-CORS: Cross-origin requests PyPI 🌏
• Flask-Migrate: DB migrations Docs 🗄️
• Flask-SQLAlchemy: ORM for Flask Docs 🐘
• Gunicorn: WSGI server Docs 🚀
• SQLAlchemy: Database toolkit Docs 🛠️

🔑 Environment Variables

Make sure your environment variables are correctly set for development (Codespaces) and deployment (Render).

• DATABASE_URL 🌐 → Your external database URL from the DB in the Render project
• JWT_SECRET_KEY 🔑 → Your generated secret string

---

💡 Tip: Keep this README handy as your quick-start guide for both front-end and back-end setup!