Stonkify

<div id="top"></div> <!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/othneildrew/Best-README-Template"> <img src="https://user-images.githubusercontent.com/78202013/150069365-94907903-35ad-4bf2-b842-e7888a2b8d21.png" alt="Logo" width="240" height="240"> </a> <h3 align="center">Stonkify</h3> <p align="center"> The Ultimate Ecommerce Web Application to buy Electronics. <br /> <a href="https://stonkify.vercel.app/"><strong>View Live Demo »</strong></a> <br /> <br /> </p> </div> <!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#features">Features</a></li> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgments">Acknowledgments</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->

About The Project

  Stonkify is a E-commerce Web Application built using technologies such as TypeScript, Nextjs, Node.js, Redux and MongoDB. The Usage of Typescript on both the Front end as well as Back end ensures type safety of the code and also helps minimizing errors(if any). The Backend Api uses MVC Architecture which helps in High Production Speed as well as Good Code splitting with DRY Principle. The Application Uses No-SQL Database i.e MongoDB which is fast and Easy to Use. Next.js Helps in Server Side Rendering and thus increasing the overall Speed of the Applicaton. Redux Toolkit is widely used for the Application wide state management. <br/>   It Has all the features that a Modern E-commerce Application has. Some of the features include Checkout(using Stripe), Adding a New Product (With Product Image)(Admin Only), Editing a Product (Admin), Authentication, Authorization and Updating User Profile.

Features

<b>Products Features</b>

| Feature | Coded? | Description | | ---------------- | :------: | :------------------------------------- | | Add a Product | ✔ | Ability of Add a Product on the System | | List Products | ✔ | Ability of List Products | | Edit a Product | ✔ | Ability of Edit a Product | | Delete a Product | ✔ | Ability of Delete a Product | | Stock | ✔ | Ability of Update the Stock | | Stock History | ✔ | Ability to see the Stock History |

<b>Purchase Features</b>

| Feature | Coded? | Description | | ------------- | :------: | :------------------------------------- | | Create a Cart | ✔ | Ability of Create a new Cart | | See Cart | ✔ | Ability to see the Cart and its items | | Remove a Cart | ✔ | Ability of Remove a Cart | | Add Item | ✔ | Ability of add a new Item on the Cart | | Remove a Item | ✔ | Ability of Remove a Item from the Cart | | Checkout | ✔ | Ability to Checkout |

<p align="right">(<a href="#top">back to top</a>)</p>

Built With

• Next.js
• React.js
• Node.js
• Redux
• TypeScript
• MongoDB

<p align="right">(<a href="#top">back to top</a>)</p> <!-- GETTING STARTED -->

Getting Started

Prerequisites

Make Sure that you have Node.js and Latest NPM Version on your local machine.

• npm

  npm install npm@latest -g
  

Installation

1. Clone the repo

   git clone https://github.com/gh0sty02/Stonkify.git
   

2. CD to Repository Folder

   cd Stonkify
   

3. Install NPM packages

   npm install
   

4. CD to Frontend Folder and install Dependencies

   cd frontend
   npm install
   

5. CD to main folder and start the server

   cd ../
   npm run dev
   

<p align="right">(<a href="#top">back to top</a>)</p> <!-- USAGE EXAMPLES -->

Feature

Search Products

<br/> <br/>

Product Review

<br/> <br/>

Checkout Screen (The Credit Card Details are Dummy XD)

<br/> <br/>

User Profile

<br/> <br/>

Product Actions (Admin)

<br/> <br/>

<p align="right">(<a href="#top">back to top</a>)</p> <!-- CONTRIBUTING -->

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p> <!-- LICENSE -->

License

Distributed under the MIT License. See LICENSE.txt for more information.

<p align="right">(<a href="#top">back to top</a>)</p> <!-- CONTACT -->

Contact

Pranay Yadav Twitter Mail

Project Link: https://github.com/gh0sty02/Stonkify

<p align="right">(<a href="#top">back to top</a>)</p> <!-- ACKNOWLEDGMENTS -->

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Mongoose
• StackOverFlow
• React-Bootstrap
• Multer
• Font Awesome
• React Icons

<p align="right">(<a href="#top">back to top</a>)</p> <!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->