Skip to content
API for tracking items during move πŸ“‹
JavaScript TypeScript CSS HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
backend
frontend
.gitignore
.prettierrc
README.md

README.md

Inventory API

An API for tracking item location during moves.

Prerequisites

In order to run the project, you'll need MongoDB installed.

Getting Started

Before you can run the project, you'll first need to create the database. The easiest way to do this is to import the mock data provided. Feel free to extend the JSON and update the model/schemas appropriately.

From the project root/backend, run:

mongoimport --db inventory --collection boxes --jsonArray mock/inventory.json

Next, build the project from the same directory:

yarn build

This will run the TypeScript compiler and generate the backend/dist/ directory. Edit the tsconfig.json file to change the output directory and other settings.

Finally, start the API server by running in the backend/ directory:

yarn start

You can’t perform that action at this time.