Project Atelier Front-End Capstone

Project Atelier is a capstone project that builds a functional and delightfully designed front-end for a high fashion e-commerce site.

Table of Contents

1. Preview and Team Members
2. Git Workflow
3. Installation Requirements

Team Member Previews

Akash Rajan - Overview module

Kiel Fuller - Related Products module

Jesse Werhnyak - Ratings and Reviews module

Git Workflow

The Krusty Krab uses a Git Feature Branch Workflow.

Collaborators should start with the main branch by using:

git checkout main
git fetch origin
git reset --hard origin/main

Once the commands above have been run, create a new branch per feature you're working on using:

git checkout -b "new-feature"

Update add, and commit as you normally would with git. To allow other collaborators to view your updates, use:

git push -u origin "new-feature"

Forgot to create a new branch? Use:

git checkout "current_branch"
git branch "new-branch"
git switch "new-branch"

Want the latest main while still working on a branch? Use:

git checkout main
git fetch origin
git reset --hard origin/main

git checkout "feature"
git merge main

Installation Requirements

This project uses React with Vite, and heavily utilizes Material UI's component library. Unit testing is done through Vitest.

Install these dependances and more after cloning the repo by running:

npm install

To compile JSX files with Vite, use:

npm run build

To create a server on your local machine using Vite, use:

npm run dev

To get a production version of this project for deployment, use:

npm run preview

Our project was deployed to an AWS EC2 instance. To learn more go to:

https://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-steps-server.html