swongg / shopify-back-end-challenge

Shopify Backend Developer Intern Challenge - Summer 2022

shopify-back-end-challenge

About the project

This is my submission to Shopify's Back End Developer Intern Challenge for Summer 2022!

• challenge specifications

Features

• Create, Read, Update, Delete operations on inventory items
• Supports image upload and storage

Screenshot

Frontend application

MongoDB database

Demo

Technologies used:

• Node/Express backend
• AWS S3 for storing image thumbnails
• MongoDB for storing inventory items

Getting Started

• /server contains the backend code
• /client contains the frontend code

Requirements

• Node v14.17.1
• AWS S3 Bucket // make sure the ACLs enabled option is selected
• An available MongoDB cluster

Installation and set up

Clone the project git clone https://github.com/swongg/shopify-back-end-challenge.git

Backend

1. In the project's /server directory, run npm install
2. In the /server/db directory, create a file named .env and add
   DB_URL="mongodb+srv://<username>:<password>@cluster0.xfgzh.mongodb.net/databasename?retryWrites=true&w=majority"
   Please note to replace username, password and databasename with your db cluster's actual values
3. In the /server/controllers directory, create a .env file and add AWS_ACCESS_KEY_ID="" and AWS_SECRET_ACCESS_KEY="". Replace the empty strings with your AWS credentials which can be found by following these instructions
4. Download the AWS CLI and in your favourite terminal, run aws configure. Enter your AWS Access Key ID and AWS Secret Access Key from step 3
5. In the /server directory, run npm run start

Frontend

1. In the project's /client directory, run npm install
2. In the same directory, run npm run start to start the React application