Skip to content

Latest commit

 

History

History
132 lines (93 loc) · 5.07 KB

README.md

File metadata and controls

132 lines (93 loc) · 5.07 KB
Raw

Meat Munchies

MeatMunchies exists because we deserver better meat. MeatMunchies is designed by taking inspiration from licious web application which is an online meat delivery platform. Objective is to deliver fresh meat in less time.

🛠 Built with

Technologies used in the project:

Javascript

React

React-Router

Redux

Chakra-UI

Node-JS

Express-JS

MongoDB

JWT

💻 Screenshots

Landing Page: Landing Page

Login Page: Login Page

OTP verification page: OTP verification page

Products and categories page: Products and categories page

Single product page: Single product page

Payment page: Payment page

✨ Features

  • User side:-

    • Register and Login page
    • Authentication using email & password
    • Products page
    • Sorting & filtering: by price, by rating, by sub-category
    • Add to cart
    • Payment page
    • Data fetching using deployed api

🚀 Demo

Front-end deployed URL:

https://meat-munchies.vercel.app/

Back-end deployed URL:

https://splendid-bear-cap.cyclic.app/

📁 Folder structure

Client - Holds the client application

  • public - This holds all of our static files

  • src

    • assets - This folder holds assets such as images, docs, and fonts

    • components - This folder holds all of the different components that will make up our pages

    • pages - These represent a unique page on the website i.e. Home or About.

    • redux - It consists of store, reducer, action and actiontypes and is responsible for global state management of our app.

    • App.js - This is what renders all of our browser routes and different pages

    • index.js - This is what renders the react app by rendering App.js.

  • package.json - Defines npm behaviors and packages for the client

Server - Holds the server application

  • config - This holds our configuration files, like mongoDB uri

  • middlewares - This holds all our middlewares used in our application

  • models - This holds all of our data models or business logic

  • routes/controllers - This holds all of our HTTP to URL path associations for each unique url

  • index.js - An entry file for our Node JS application

package.json - Defines npm behaviors like the scripts defined in the next section of the README

.gitignore - Tells git which files to ignore

README - This file!

Installation

Clone the project

git clone https://github.com/sanghamitra0591/meat-munchies.git

Client-side usage

Go to the project directory

$ cd client          // go to client folder
$ yarn # or npm i    // npm install packages
$ npm run start        // run it locally

// deployment for client app
$ npm run build // this will compile the react code using webpack and generate a folder called docs in the root level

Server-side usage

Environment Variables:-

To run this project, you will need to add the following environment variables to your .env file

port                    // the port on which the server will run
mongo_url              // your mongoDB URI to connect to the mongoDB atlas
JWT_SECRET                     // key which will be JWT secret key

Start

$ cd server            // go to server folder
$ npm i                 // npm install packages
$ npm run server        // run it locally

✍ Authors