A web application to manage recipes, products, and automatically generate weekly lunch/dinner menus.

• Recipe Management: Create, edit, and organize recipes with ingredients, instructions, difficulty levels, and preparation times
• Product Catalog: Maintain a catalog of products/ingredients used in recipes
• Weekly Menu Generation: Automatically generate balanced weekly menus for lunch and dinner
• Daily Menu Planning: Plan meals for each day with lunch and dinner options
• Side Dishes: Associate side dishes with main recipes
• Seasonal Recipes: Tag recipes by season (spring, summer, autumn, winter)
• Recipe Types: Categorize recipes (meat, fish, vegetables, legumes, pasta, rice, etc.)
• Meal Temperature: Classify recipes as warm or cold meals
• OpenAI Integration: AI-powered menu generation suggestions
• Multi-language Support: Available in English and Spanish
• Responsive UI: Modern interface built with Mantine UI components
• API Documentation: Swagger/OpenAPI documentation

• Python 3.10+
• Django 4.2 - Web framework
• Django REST Framework - API development
• uv - Fast Python package manager
• MariaDB/MySQL/SQLite - Database options
• Gunicorn - WSGI HTTP Server
• Sentry - Error tracking

• React 18 - UI library
• TypeScript - Type safety
• Vite - Build tool
• Mantine 7 - UI component library
• React Query - Server state management
• React Router 6 - Routing
• i18next - Internationalization
• Axios - HTTP client
• TipTap - Rich text editor
• Chart.js - Data visualization

• Docker & Docker Compose - Containerization
• Nginx - Reverse proxy
• GitHub Actions - CI/CD (optional)

• Python 3.10 or higher
• Node.js 22 or higher
• uv (Python package manager)
• Docker & Docker Compose (for production deployment)

1. Clone the repository:

   git clone https://github.com/renefs/cociplan.git cd cociplan

2. Install Python dependencies:

   uv sync

3. Create environment configuration:

   cp .env.ci.sample .env # Edit .env with your settings

4. Run database migrations:

   cd backend uv run python manage.py migrate

5. Create a superuser (optional):

   uv run python manage.py createsuperuser

6. Start the development server:

   uv run python manage.py runserver

The backend API will be available at http://localhost:8000.

1. Navigate to the client directory:

   cd client

2. Install dependencies:

   npm install

3. Create environment configuration:

   cp .env.local.example .env.local # Edit .env.local with your settings

4. Start the development server:

   npm start

The frontend will be available at http://localhost:5173.

1. Create production environment file:

   cp .env.ci.sample .env.prod # Edit .env.prod with production settings

2. Build and start containers:

   docker-compose up -d --build

3. Run migrations:

   docker-compose exec backend python manage.py migrate

The application will be available at http://localhost:8080.

Once the backend is running, API documentation is available at:

• Swagger UI: http://localhost:8000/swagger/
• ReDoc: http://localhost:8000/redoc/
• OpenAPI Schema: http://localhost:8000/swagger.json

cociplan/ ├── backend/ # Django backend │ ├── cociplan/ # Main Django project │ ├── menus/ # Menus app (recipes, products, menus) │ ├── initialize_data/ # Data initialization utilities │ └── config/ # Configuration files ├── client/ # React frontend │ ├── src/ │ │ ├── api/ # API client │ │ ├── components/ # Reusable components │ │ ├── pages/ # Page components │ │ ├── hooks/ # Custom hooks │ │ ├── locales/ # i18n translations │ │ └── types/ # TypeScript types │ └── public/ # Static assets ├── data/ # SQLite database (development) ├── media/ # User uploaded files ├── nginx/ # Nginx configuration ├── docker-compose.yml # Docker Compose configuration ├── Dockerfile # Backend Dockerfile └── docker.client.Dockerfile # Frontend Dockerfile 

Backend:

cd backend uv run pytest

Frontend:

cd client npm test

Backend:

# Linting uv run flake8 # Type checking uv run mypy . # Formatting uv run black . uv run isort .

Frontend:

# Linting npm run lint # Formatting npm run prettier:fix

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Rene Fernandez - renefernandez@duck.com