Shopify Backend Intern Challenge

Introduction

This project is for the Fall 2022 Shopify Backend Developer Intern Challenge. It is an inventory tracking web application capable of performing the functional requirements listed below.

Project Layout

This application was built with the Next.js framework. Therefore, files inside the pages/api folder are mapped to /api/* REST endpoints. For example, the HTTP handler in pages/api/v1/items/[id].ts maps to /api/v1/items/{id}. The HTTP handler in pages/api/v1/items/index.ts maps to /api/v1/items. The code for each HTTP handler can be seen in pages/api.

The application talks to an SQLite database on the backend. The database file is prisma/dev.db. HTTP handlers call functions inside of repo/db to perform database operations.

Similarly, on the frontend, Next.js maps React components in pages/ to webpage, excluding files in /pages/api. For example, pages/index.tsx maps to the root index, /. The component inside of pages/items/edit/[id].tsx maps to /items/edit/{id}, where {id} is a valid ID for an inventory item. React components inside of pages/ call functions inside of repo/api to perform HTTP requests to the backend.

Functional Requirements and Instructions

Create inventory items:
- From the index page, click on the Create item link.
Edit inventory items:
- From the index page, click on the Edit link beside an item you want to edit.
Delete inventory items:
- From the index page, click on the Edit link beside an item you want to delete.
- On the edit page, click on the Delete item button.
View a list of inventory items:
- The index page displays a list of all items.
Ability to create “shipments” and assign inventory to the shipment, and adjust inventory appropriately:
- From the index page, click on the Create shipment link.
- Click on the plus button [ + ] beside any of the "Available items" to add it into the "Shipping Items" cart. More than one item can be added to the cart.
- Once at least one item is added to the "Shipping Items" cart, click on the Process Shipment button. Going back to the index page, the updated quantities are shown.

View on Replit

I have deployed the application using Replit. You can view the live application at: https://shopify-backend-challenge.nikolasnorth.repl.co

The repl can be found at: https://replit.com/@NikolasNorth/shopify-backend-challenge

API routes can be accessed under /api/v1.

Local Setup Instructions

# Install application dependencies
npm install

# Create database, schema and run seed script
npx prisma migrate dev

# Build application
npm run build

# Launch application
npm run start