Stonkify

The Ultimate Ecommerce Web Application to buy Electronics.

Table of Contents

About The Project
- Features
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Contributing
License
Contact
Acknowledgments

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.

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

Products Features

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

Purchase Features

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

(back to top)

Built With

(back to top)

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

Clone the repo

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

CD to Repository Folder
```
cd Stonkify
```
Install NPM packages
```
npm install
```
CD to Frontend Folder and install Dependencies
```
cd frontend
npm install
```
CD to main folder and start the server
```
cd ../
npm run dev
```

(back to top)

Feature

Search Products

Product Review

Checkout Screen (The Credit Card Details are Dummy XD)

User Profile

Product Actions (Admin)

(back to top)

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!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.
(back to top)

Contact

Pranay Yadav Twitter Mail
Project Link: https://github.com/gh0sty02/Stonkify
(back to top)

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!

(back to top)