FEC Plumbers Atelier

FEC Plumbers Atelier is a full-stack web application built to replicate the experience of a physical atelier. It is a place for people to browse and purchase custom-made products.

Table of Contents

1. Description
2. Technologies Used
3. Installation and Running
4. Sample .env file
5. Authors and Contributors
6. Wins and Improvements

Description

FEC Atelier is a full-stack web application developed to replicate the experience of a physical atelier, where people can browse and purchase custom-made products. It was built using React, Amazon AWS, Express.js, Jest, Node.js, MySQL, and Sequelize.

The application allows users to view products, create accounts, add items to their carts, and purchase items.

Technologies Used

Installation and Running

To get the project running, first clone the repository:

git clone https://github.com/username/PLUMBERSFEC.git

Then install the dependencies:

npm install

Finally, run the project:

> npm run client-dev

then:

> npm run server-dev

then run http://localhost:3000

Sample .env file

This project requires a .env file in order to connect to the database. The file should include the following information:

PORT=
API_KEY=

Authors and Contributors

The authors and contributors of this project are:

• Sara Li
• Eric Lee
• Dillon Migdol
• Cesar Guajardo

Wins and Improvements

The project was successful in replicating the experience of a physical atelier with a web application. The application allows users to browse and purchase products.

The project could be improved upon in terms of user experience and scalability. The user experience could be improved by adding more features, such as a wishlist. Additionally, the application could be made more scalable by refactoring the code and adding more caching.

PLUMBERSFEC

HackReactor FEC

To make new branch:

Step 1: Clone the master repo(if you haven't already, if you have then skip to step 2)

 > git clone <url of master repo>

Step 2: Create new Branch

 > git branch <name of new branch>

Step 3: Go to new Branch

 > git checkout <name of new branch>

Step 4: Make sure you are in new branch

 > git branch

You should see something like this:

> git branch
   master
   *<name of new branch>

Step 5: Rebasing and merging into branches

Stash work before doing so

> git stash

Move to branch

> git checkout main (whater your main branch in called)

Pull down from GH

> git pull origin main

Move to branch and merge

> git checkout 'BRANCH_NAME'

> git merge main

Now head to VSCode to resolve conflict issues for rebase

After rebase merge is complete, reload in stashed items

> git stash list (to view what will be added back in)
> git stash pop (to add back to branch)

DEPENDENCIES

Webpack, Webpack CLI

Nodemon

eslint using HR linter config

ReactJS

ExpressJS

Jest

React testing library

Babel

Font Awesome