README.md

alssweeper

E-commerce website made for a local vacuum and sewing machine repair business.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• Next.js
• React.js
• Tailwindcss
• Commerce.js
• Redux Toolkit
• Next SEO
• React Fast Marquee
• React Hook Form
• React Hot Toast
• React Icons
• Variant Classnames
• SendGrid

(back to top)

Getting Started

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

Prerequisites

• Node.js
• npm

  npm install npm@latest -g

Installation

1. Get a free Commerce.js API Key at https://commercejs.com/
2. Get a free SendGrid API Key at https://sendgrid.com/
3. Clone the repo

   git clone https://github.com/raymondkneipp/alssweeper.git

4. Install NPM packages

   npm install

5. Enter your API keys in .env.local

   NEXT_PUBLIC_CHEC_PUBLIC_API_KEY="your Commerce.js API key"
   SENDGRID_API_KEY="your SendGrid API key"
   EMAIL="email to send form submissions to"
   

6. Start local server

   npm run dev

(back to top)

Usage

Feel free to change the information presented on this webpage and create your own website.

(back to top)

Roadmap

• Add SendGrid
  • Contact form functionality
  • Honey pot filter
• Custom checkout

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

Raymond Kneipp - @rfkquery - [email protected]

Project Link: https://github.com/raymondkneipp/alssweeper

(back to top)

Acknowledgments

• React Architecture
• Best README Template

(back to top)