Skip to content

Latest commit

 

History

History
228 lines (158 loc) · 6.86 KB

README.md

File metadata and controls

228 lines (158 loc) · 6.86 KB
Raw

Netlify Status


Logo

Material Storefront

This is a Storefront for Saleor, in Next.js using Material-UI (MUI), Apollo and Code Generator.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

![Product Name Screen Shot][product-screenshot]

This is a Storefront for Saleor, in Next.js using Material-UI (MUI), Apollo and Code Generator.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • npm

    npm install npm@latest -g

  • yarn

    npm install --global yarn

Installation

  1. Clone the repo 
    git clone https://github.com/Rasmez/material-storefront.git
  2. Install NPM packages 
    yarn install
  3. Start hacking!

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • [] Feature 1
  • [] Feature 2
  • [] Feature 3
    • [] Nested Feature

See the open issues for a full list of proposed features (and known issues).

(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!

  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

(back to top)

License

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

(back to top)

Contact

Your Name - @twitter_handle - email@email_client.com

Project Link: https://github.com/Rasmez/material-storefronte

(back to top)

Acknowledgments

(back to top)