Petlify

Petlify

A pet shop app & admin dashboard.

View website | View documentation

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Contact

About The Project

This is a pet shop application written using Typescript, React.js, Redux Toolkit, Node.js, MongoDB and Tailwind CSS. It features a home page that displays a list of categories and a list of products. Users are able to sign up / sign in with Google authentication, access their user page and edit their user information. Users are also able to select which product they want to order as well as several different options for their order, checkout using Paypal or cash on delivery, and track their order. The app also features an admin dashboard which allows admins to view, create, modify and delete products, orders, users and admins.

(back to top)

Built With

• Tailwind CSS
• Typescript
• React.js
• Redux Toolkit
• Node.js
• MongoDB
• Mongoose

(back to top)

Getting Started

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

Installation

1. Clone the repo
   
   

   git clone https://github.com/ioanat94/petlify.git

2. Install NPM packages
   
   

   cd api
   yarn install
   cd ..
   cd client
   yarn install

3. Start server
   

   cd api
   yarn start:dev
   cd ..
   cd client
   yarn start

(back to top)

Usage

• Sign up / sign in via Google Authentication.
• View or edit your profile information.
• Browse landing page to see a list of categories and a list of products.
• Click on a product to see more information.
• Choose product size and variant, and add to cart.
• Cick on the cart icon in the top right to view the contents of your cart.
• Click the 'X' to remove an item from your cart.
• Enter the delivery address and choose to pay via cash on delivery or PayPal, then check out.
• Follow the order page to see the status of your order.
• Admin dashboard:
  • Navigate to https://petlify.vercel.app/admin and log in.
  • View recent data on the admin dashboard main page.
  • Manage products, orders, users and admins on their respective pages.

(back to top)

Contact

Ioana Tiplea - ioanatiplea94@gmail.com - LinkedIn

Project Link: https://github.com/ioanat94/petlify

(back to top)