Skip to content

Latest commit

 

History

History
228 lines (156 loc) · 8.41 KB

README.md

File metadata and controls

228 lines (156 loc) · 8.41 KB

Table of Contents
  1. Overview
  2. Built With
  3. Getting Started
  4. Contributing
  5. Contact
  6. License

Overview

This eCommerce website was created for a home crafts business. Through building this site, I've deepened my understanding of authentication systems, integrated payments, and AWS for hosting and managing web applications.

Highlights:

  • Secure Sign-In Options: Choose between OAuth (Google or Facebook) and traditional email / password
  • Hosting with AWS: Hosted on Amazon Web Services to enable scalability, security, and performance
  • Stripe and PayPal Checkout: Secure and versatile payment options to adhere to customer preferences

I hope the site provides you with an welcoming and enjoyable shopping experience.

(back to top)

Built With

JavaScript TypeScript HTML5 CSS3 React Tailwind CSS Next JS PostgreSQL Prisma NextAuth Google OAuth Facebook OAuth JWT Cookies Docker PayPal Stripe AWS AWS EC2 AWS ECR AWS RDS AWS SES AWS S3 AWS Secrets Manager

(back to top)

Getting Started

This section provides instructions on how to get a local copy of the website up and running.

Prerequisites

Before installing, make sure you have the following tools installed:

  • Node.js: The runtime environment for executing JavaScript code server-side. You can download it from Node.js official website.

  • npm (Node Package Manager): Comes with Node.js, but you can check if it's installed by running npm -v in your terminal. If you need to update npm, run:

    npm install npm@latest -g

Installation

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

  1. Clone the repository Begin by cloning the repository to your local machine:

    git clone https://github.com/austin-cavanagh/b2c-ecommerce-website.git

  2. Navigate to the project directory Enter directory after cloning:

    cd b2c-ecommerce-website

  3. Install dependencies Install the necessary packages using npm:

    npm install

  4. Start the development server To start the Vite development server run:

    npm run dev

  5. Build for production To build the project for production, use:

    npm run build

    After building, you can preview the production build locally by running:

    npm start

  6. Happy coding!

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

Contact

Austin Cavanagh - GitHub - LinkedIn - [email protected]

(back to top)

License

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

(back to top)