Koscee / recipedia

An online recipe manual

Recipedia ·

This is a simple online recipe manual. Visit the Recipedia website to view the live demo.

Table of Contents

• Features
• Technologies
• Getting Started
  • Prerequisites
  • Installation
• ESLint Configuration
  • Running ESLint
• Contributing

Features

• Add, edit, and delete recipes
• View recipe details
• View recipe instructions
• Search for recipes upcoming feature
• Filter recipes by category upcoming feature
• View recipe ingredients upcoming feature
• View recipe nutrition facts upcoming feature
• View recipe reviews upcoming feature

Technologies

• React v18
• Vite
• TypeScript v5
• ESLint
• React Router v6
• Supabase
• Docker will be added soon

Getting Started

Prerequisites

• Node.js 20.x
• Yarn v1.22.21
• Supabase

Installation

1. Clone the repository

git clone

2. Install dependencies

yarn install

3. Login to your Supabase account and create a new project. Ensure to copy the project URL and anon key.

4. Create a new table named recipes in the Supabase project with the following columns:

• id (type: integer, primary key)
• title (type: text, not null)
• method (type: text, not null)
• rating (type: integer, min: 0, max: 5)
• created_at (type: timestamp, default: now())

5. Create a .env.local file in the root directory and add the following environment variables:

VITE_APP_SUPABASE_URL=
VITE_APP_SUPABASE_ANON_KEY=

6. Start the development server

yarn dev

ESLint Configuration

This project uses ESLint to enforce code quality and consistency.

Running ESLint

To run ESLint, use the following command:

yarn lint

Contributing

Contributions are welcome! Please refer to the contributing guidelines for more information.