Skip to content

README.md

Latest commit

 

History

History
46 lines (27 loc) · 1.49 KB

README.md

File metadata and controls

46 lines (27 loc) · 1.49 KB

FUDI

Fudi is a food-related social media platform where users can share their reviews of restaurant items with their network of friends. The platform was built using a React frontend to interact with a CRUD API using AWS Lambda, API Gateway, and Dynamo DB.

Features

  • Share reviews of restaurant items with friends and followers
  • Discover new dishes and restaurants based on recommendations from the community
  • Interact with other users by commenting on and liking their reviews
  • Build a network of friends and foodies with similar tastes
  • Keep track of your favorite dishes and restaurants in your personal profile

Installation

To run this project, you'll need to have Node.js and npm installed on your machine. Follow the steps below to get started:

  1. Clone the repository to your local machine:

git clone https://github.com/michaelgriff/fudi.git

  1. Navigate to the project directory:

cd fudi

  1. Install the dependencies:

npm install

  1. Start the development server:

npm start

The application should now be running on http://localhost:3000.

Contributing

If you're interested in contributing to this project, please follow the guidelines below:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your changes (e.g. feature/new-feature).
  3. Make your changes and commit them to your branch.
  4. Push the changes to your fork and submit a pull request to the master branch.

License

This project is licensed under the MIT license.