Skip to content

jlwhittaker/stockr

Repository files navigation

Stockr

Here's how it works:

Your inventory consists of items, called 'stocks'. Once you have items in stock, there's a few things you can do:

  • Place an order for more
  • Update an order status
  • Sell some of the stock
  • Set up an alert

Updating an order status to 'Completed' will automatically update the quantity that you have in stock. Same goes for selling an item.

There are two types of alerts -- low stock, and out-of-stock. When an alert gets triggered, you'll be able to see it on the dashboard. Clicking the checkbox next to the alert notification will dismiss the alert. Any change to the item quantity (whether via an order or sale), will re-trigger any relevant alerts. Alerts can be turned on and off on the Alert page.

Feel free to create your own user, but please don't use any credentials that you use for something else. The default login is:

Username: "test"

Password: "pw"

Note: This page is open to the public, so it's possible that some unscrupulous users may have added some ... questionable content to the default account. The database gets reset every day, though.

Compiling yourself

The compilation process is handled by the Docker container. The HTTP server functionality is handled by Kestrel, but all of that is abstracted away for the most part. All you really need to do is build and run the container, choosing which port to expose. From inside the directory with the Dockerfile, you can run:

docker build -t stockr .

Now that the container is built, run it using

docker run -p 8888:80 -d stockr

to use port 8888 on the host machine.

About

Inventory Management

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published