PlateCritique

A vibrant social platform for food enthusiasts to share and rate their favorite dishes.
Explore PlateCritique Click Here»
https://platecritique.up.railway.app/

Table of Contents

1. About The Project
2. Built With
3. Getting Started
   • Prerequisites
   • Installation
4. Deployment
5. Contact

About The Project

PlateCritique is a full-stack CRUD web application designed for food lovers to share and critique dishes. Users can upload posts with detailed information including titles, food types, ratings (out of 5 stars), descriptions, and images. The platform is fully hosted online and aims to build a community where users can discover and share culinary delights.

Key Features

• Rating System: Users can rate the food out of 5 stars.
• Post Creation: Users can create posts with detailed dish information and images.
• CRUD Operations: Easily create, read, update, and delete posts.
• Responsive Design: Fully responsive UI ensuring a seamless experience across devices.
• Live Deployment: Hosted on Railway for public access.

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Ensure you have the following installed:

• Node.js: Download and install Node.js
• MongoDB: Set up MongoDB

Installation

1. Clone the repository:

   git clone https://github.com/Amyat103/PlateCritique.git
   

2. Navigate to the project directory and Install backend and dependencies:

   cd platecritique
   cd backend
   npm install
   cd ../frontend
   npm install
   

3. Set up environment variables::

   PORT=5000
    MONGODB_URI=your_mongodb_connection_string

Running the Application

1. Start the backend server:

   cd backend
   npm run dev

2. Start the frontend server:

   cd ../frontend
   npm run dev

The application should now be running at http://localhost:5000 (or where you specified it).

Deployment

PlateCritique is hosted on Railway. The application is automatically deployed whenever changes are pushed to the main branch. Environment variables are configured to ensure secure and smooth operation.

You can monitor the deployment status and manage the application directly from the Railway dashboard.

(back to top)

Contact

For feedback, questions, or suggestions, please reach out:

• Email: [email protected]
• Email: [email protected]
• LinkedIn: https://www.linkedin.com/in/davidmyat/

Feel free to connect and discuss any aspects of the project or to provide valuable feedback.

(back to top)

TODO

Fix CSS for BootStrap, maybe change to tailwind