View Code? Open in Web Editor
NEW
Inventory tracking backend that implements CRUD for items and shipments.
inventory-tracking's Introduction
- Download the codebase onto a local environment
- Download the dependencies with
npm install. If running in a production environment, run npm build next.
- Run either
npm run start:dev or npm run start:prod.
- Go to http://localhost:5000/docs/#/ (CURL and Postman works too)
- If using Swagger, click the endpoint,
try it out, enter in the information, and then execute.
- Runtime: Node.js
- Language: TypeScript (with ESM)
- Framework: Express.js
- Database: LowDB
- Testing Framework: Jest
- Frontend/Documentation: Swagger
- Code Formatting: Prettier using Shopify conventions
- Code Linting: ESLint using Shopify conventions
npm install - Downloads dependencies (will need to be run if running locally)npm run start:dev - Run the project in a development environmentnpm run start:prod - Run the project in a production environment (will need to be built first)npm run build - Builds the project for running in a production environmentnpm run test:unit - Running the unit testsnpm run code:format - Formatting the code to Shopify conventionsnpm run code:lint - Linting the code to Shopify TypeScript conventionsnpm run swagger - Builds the projects frontend/documentation
Features (Basic CRUD Functionality)
- Create inventory items
- Edit inventory items
- View a list of inventory items
- View single inventory items
- Delete inventory items
- Ability to create “shipments”, assign inventory to the shipment, and adjust inventory appropriately
- View single shipments
inventory-tracking's People
Contributors
Watchers
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent