Skip to content

A react recipe App made for Nigerians in diaspora that allows users to vıew recipes, check locatıons to get local meals, nutrıtıonal benefıts and make comments. Thıs was built with react JS, SCSS and HTML

Notifications You must be signed in to change notification settings

Elizabethcodes44/react-naija-recipe-App

Repository files navigation

🍲 Epicurean Adventures 🍽️

Welcome to Epicurean Adventures! This food blog app is your ultimate guide to exploring and sharing culinary delights. From delectable recipes and refreshing beverages to seasonal specials, our platform offers a rich tapestry of food content. Whether you're a passionate cook or a food enthusiast, you'll find a wealth of features to satisfy your gastronomic cravings.

📝 User Stories

  • 🍴 Users can browse through various categories, including recipes, beverages, and seasonal dishes.
  • 📸 Users can upload images to enhance their posts and share their culinary creations.
  • ✍️ Users can view their profile, including published and draft posts, and manage their account details.
  • 💬 Users can comment on, like, or dislike posts to engage with the content and other users.
  • 🌟 Users can save their favorite recipes and dishes to a personalized wishlist for quick access.
  • 🔍 Users can search for recipes and dishes based on ingredients, categories, and more.
  • 🏷️ Users can filter posts by category to find specific types of content quickly.

🚀 Features

  • Role-Based Access: Different roles (users, authors, admins) with tailored permissions.
  • Image Uploads: Authors and users can upload images to accompany their posts and profiles.
  • Responsive Design: The app is fully responsive, ensuring a seamless experience on both mobile and desktop devices.
  • Search Functionality: Find recipes and beverages quickly with advanced search filters.
  • Commenting and Feedback: Engage with content through comments, likes, and dislikes.
  • Wishlist: Save your favorite recipes and dishes for easy retrieval.
  • Profile Management: View and edit profiles, and manage published and draft posts.

🛠️ Installation

To get started with Epicurean Adventures, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/yourusername/epicurean-adventures.git
  2. Install Dependencies:

    npm install
  3. Set Up the Database:

    • Ensure PostgreSQL is installed and running.
    • Create a new database and set up the necessary tables and roles.
  4. Configure Environment Variables:

    • Create a .env file in the root directory with your database configuration and other environment variables.
  5. Run the Application:

    npm run dev
  6. Navigate to the Blog:

    • Open your browser and go to http://localhost:3000 to explore the food blog.

🧰 Technologies Used

  • React: For building dynamic user interfaces.
  • Tailwind CSS: For responsive and modern styling.
  • React Router: For handling routing and navigation.
  • PostgreSQL: For managing and storing data with role-based access.
  • Node.js: Backend server to handle API requests and database interactions.

📦 Extensions We Need

  • 🌐 GitHub Preview: Add a GitHub preview extension to enhance repository visibility.
  • 🔒 Security Enhancements: Implement additional security measures for user authentication and data protection.

📚 Documentation

  • Database Schema: Details on the PostgreSQL database schema, including tables and relationships.
  • API Endpoints: Documentation for API endpoints used for CRUD operations on posts, user profiles, and comments.
  • Component Structure: Overview of the React component structure and their functionalities.

👤 Roles and Permissions

Authors

  • Post Content: Authors can create and publish new posts, including recipes, beverages, and seasonal dishes.
  • Upload Images: Authors can upload images to accompany their posts.
  • Manage Posts: Authors can view and edit their own published and draft posts.
  • View Profile: Authors can view and manage their profiles, including personal details and post history.

Admins

  • Manage Users: Admins can view and manage all users and their roles.
  • Manage Authors: Admins can view and manage all authors, including their posts and profiles.
  • Manage Posts: Admins can view, edit, or delete any post across the platform.

🎨 Theming

  • Epicurean Adventures does not currently support theming. The design is consistent across light and dark modes.

🧑‍💻 Authors


About

A react recipe App made for Nigerians in diaspora that allows users to vıew recipes, check locatıons to get local meals, nutrıtıonal benefıts and make comments. Thıs was built with react JS, SCSS and HTML

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published