This repository is a part of MaksimAniskov/aws-ssg-ecommerce.

Content of the repository was derived from jamstack-cms/jamstack-ecommerce.

The software and data available in this repository are provided "as is" without warranty of any kind, either express or implied. Use at your own risk.

1. Clone the project

$ git clone https://github.com/MaksimAniskov/aws-ssg-ecommerce-jam.git

2. Install the dependencies:

$ yarn

# or

$ npm install

3. Create shop "database" or "install" demo database

Create shop folder and populate it with the data and product images:

$ mkdir shop

or;
Clone the demo database into a folder next to the app's one and create a link to it:

$ cd ..
$ git clone https://github.com/MaksimAniskov/aws-ssg-ecommerce-demoshop.git
$ cd aws-ssg-ecommerce-jam
$ ln -s ../aws-ssg-ecommerce-demoshop shop

Use MaksimAniskov/aws-ssg-ecommerce-demoshop as the reference on data structure.

4. Create settings.json

$ cp settings.example.json settings.json
$ vi settings.json

5. Build then run the project
   (Build step is necessary to generate optimized images of products)

$ yarn build
$ yarn develop

# or

$ npm run-script build
$ npm run-script develop

This project is styled using Tailwind. To learn more how this works, check out the Tailwind documentation here.

The main files, components, and images you may want to change / modify are:

Logo - src/images/logo.png
Buttons, Nav, Header - src/components
Form components - src/components/formComponents
Context (state) - src/context/mainContext.js
Pages (admin, cart, checkout, index) - src/pages
Templates (category view, single item view, inventory views) - src/templates

As it is set up, inventory and product images are fetched from local files in shop sub-folder. On AWS the files are to be copied from S3 bucket by CodePipeline. See MaksimAniskov/aws-ssg-ecommerce.