Skip to content

s-rybak/foodies-app

Repository files navigation

Foodies - Recipe Sharing Platform

Project Overview

Foodies is a website designed to allow users to create, manage, and share their recipes with a community. Users can register, log in, and manage their profiles, including following other users, viewing follower counts, and exploring a curated list of favorite recipes. The app provides a seamless experience for food enthusiasts to discover new recipes, connect with like-minded users, and build a personalized recipe collection.

Table of Contents

  1. Features
  2. Technologies and Libraries
  3. Installation
  4. Foodies Postman Documentation
  5. Foodies Backend Repository
  6. Team Members

1. Features

These features highlight the core functionalities of the app. (Screenshots will be attached later.)

User Registration & Authentication

  • Users can sign up and log in using a secure authentication system.
  • JWT-based token authentication for secure API access.

Profile Management

  • Users can view and edit their profile information, including name, email, and avatar.
  • View followers and users they are following.

Recipe Creation & Management

  • Users can create, edit, and delete their own recipes.
  • Track the number of recipes created by each user.

Favorite Recipes

  • Users can mark recipes as favorites and access their personalized list of favorite recipes.

Follow Other Users

  • Users can follow other users to see their shared recipes and content.
  • View follower count and following count on user profiles.

Recipe Discovery

  • Explore recipes shared by the community, including those from users you follow.

Error Handling & Validation

  • Robust error handling and validation for user actions, including invalid input and missing data.

2. Technologies and Libraries

Frontend

  • HTML/CSS
  • JavaScript
  • Dependencies:
    • @babel/core
    • @fortawesome/fontawesome-free
    • @fortawesome/fontawesome-svg-core
    • @fortawesome/free-brands-svg-icons
    • @fortawesome/free-regular-svg-icons
    • @fortawesome/free-solid-svg-icons
    • @fortawesome/react-fontawesome
    • @hookform/resolvers
    • @reduxjs/toolkit
    • @testing-library/jest-dom
    • @testing-library/react
    • @testing-library/user-event
    • axios
    • classnames
    • dotenv
    • modern-normalize
    • react
    • react-dom
    • react-hook-form
    • react-loader-spinner
    • react-modal
    • react-redux
    • react-router-dom
    • react-scripts
    • react-select
    • react-toastify
    • redux
    • redux-persist
    • sass
    • web-vitals
    • yup

Backend

  • Node.js
  • Dependencies:
    • bcrypt
    • cors
    • dotenv
    • express
    • joi
    • jsonwebtoken
    • morgan
    • multer
    • nodemailer
    • pg
    • sequelize
    • sequelize-cli
    • uuid

3. Installation

  1. Clone the repository:

    git clone https://github.com/s-rybak/foodies-app.git
  2. Navigate to the project directory:

    cd foodies-app
  3. Install dependencies:

    npm install
  4. Start the development server:

    npm start

    The app will be available at http://localhost:3000.

4. Foodies Postman Documentation

The API documentation is available on Postman for detailed interaction with the backend services

5. Foodies Backend Repository

Foodies Backend Repository

6. Team Members

Fork & Code team members:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published