# README

[![](https://img.shields.io/github/contributors/juniHub/jamstack-ecommerce-nextjs.svg?style=for-the-badge)](https://github.com/juniHub/jamstack-ecommerce-nextjs/graphs/contributors) [![](https://img.shields.io/github/forks/juniHub/jamstack-ecommerce-nextjs.svg?style=for-the-badge)](https://github.com/juniHub/jamstack-ecommerce-nextjs/network/members) [![](https://img.shields.io/github/stars/juniHub/jamstack-ecommerce-nextjs.svg?style=for-the-badge)](https://github.com/juniHub/jamstack-ecommerce-nextjs/stargazers) [![](https://img.shields.io/github/issues/juniHub/jamstack-ecommerce-nextjs.svg?style=for-the-badge)](https://github.com/juniHub/jamstack-ecommerce-nextjs/issues) [![](https://img.shields.io/github/license/juniHub/jamstack-ecommerce-nextjs.svg?style=for-the-badge)](https://github.com/juniHub/jamstack-ecommerce-nextjs/blob/master/LICENSE.txt)

 [![Logo](https://2294342411-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MacaBBWvp7iDE1zpFjK%2Fsync%2F93631515789b36c1adf512cce5474c201d45ad0e.png?generation=1622031323992537\&alt=media)](https://github.com/juniHub/jamstack-ecommerce-nextjs)

### Juni E-commerce

 project\_description\
 [**Explore the docs »**](https://github.com/juniHub/jamstack-ecommerce-nextjs)\
\
 [View Demo](https://juni-ecommerce.vercel.app/) · [Report Bug](https://github.com/juniHub/jamstack-ecommerce-nextjs/issues) · [Request Feature](https://github.com/juniHub/jamstack-ecommerce-nextjs/issues)

## Table of Contents

1.  [About The Project](#about-the-project)
   * [Built With](#built-with)
2.  [Getting Started](#getting-started)
   * [Prerequisites](#prerequisites)
   * [Installation](#installation)
3. [Usage](#usage)
4. [Roadmap](#roadmap)
5. [Contributing](#contributing)
6. [License](#license)
7. [Contact](#contact)
8. [Acknowledgements](#acknowledgements)

## About The Project

### Public Page

![Juni-jamstack-ecommerce-nextjs -screenshot](https://res.cloudinary.com/dafolrlpj/image/upload/v1627304393/gallery/lpw7aigx8h6hyywromse.png)

### Admin Page

![Juni-jamstack-ecommerce-nextjs -adminpage](https://res.cloudinary.com/dafolrlpj/image/upload/v1622029925/gallery/lddrvbfwcgykyolathud.png)

### Built With

* [NextJS](https://nextjs.org/)
* [MongoDB](https://www.mongodb.com/)
* [Cloudinary](https://cloudinary.com/)
* [Bootstrap](https://getbootstrap.com/)
* [Deployed on Vercel](https://vercel.com/)

## Getting Started

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

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.

* npm

  ```bash
  npm install npm@latest -g
  ```

### Installation

1. Clone the repo

   ```bash
   git clone https://github.com/juniHub/jamstack-ecommerce-nextjs.git
   ```
2. Install NPM packages

   ```bash
   npm install
   ```
3. Connect to your mongodb and add info in

   ```bash
   .env.local
   ```
4. Run the project locally on <http://localhost:3000>

   ```bash
   npm run dev
   ```

## Usage

*For more examples, please refer to the \[\_Documentation*]\(<https://junitiennguyen.gitbook.io/ecommerce>). This will be continued for update and maintainance.\_

## Roadmap

See the [open issues](https://github.com/juniHub/jamstack-ecommerce-nextjs%20/issues) for a list of proposed features (and known issues).

## Contributing

Contributions are what make the open source community such an amazing place to be learned, inspired, and created. Any contributions you make are **greatly appreciated**.

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

## License

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

## Contact

Juni Nguyen - [helloJuni](https://hellojuninguyen.netlify.app/)

Project Link: [https://github.com/juniHub/jamstack-ecommerce-nextjs ](https://github.com/juniHub/jamstack-ecommerce-nextjs)

## Acknowledgements

Inspired by ecommerce project from [Devat-Youtuber](https://github.com/devat-youtuber/nextjs-ecommerce)