https://github.com/datasektionen/zaiko
https://github.com/datasektionen/zaiko
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/datasektionen/zaiko
- Owner: datasektionen
- License: agpl-3.0
- Created: 2024-11-07T20:36:47.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-28T19:39:43.000Z (4 months ago)
- Last Synced: 2025-02-28T23:00:13.461Z (4 months ago)
- Language: Vue
- Size: 423 KB
- Stars: 1
- Watchers: 17
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zaiko
prototype of an inventory management system for the computer science chapter at KTH university
# API
| Endpoint | Method | Input | Output |
|---------------|--------------|---------------------------------------------|----------------------------------------------------------|
| item | get | - | id name location min max current supplier link updated |
| | post | name location min max current supplier link | - |
| | patch | name location min max current supplier link | - |
| | delete | query(id) | - |
| supplier | get | - | id name link notes username password |
| | get | query(id) | name |
| | post | name link notes username password | - |
| | patch | name link notes username password | - |
| | delete | query(id) | - |
| stock | get | - | List(id name location current min order) |
| | post | List(id amount) | - |
| log | get | query(id) | List(amount time) |
## Type Support for `.vue` Imports in TS
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
## Customize configuration
See [Vite Configuration Reference](https://vite.dev/config/).
## Project Setup
```sh
bun install
```
### Compile and Hot-Reload for Development
```sh
bun dev
```
### Type-Check, Compile and Minify for Production
```sh
bun build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
bun test:unit
```
### Run End-to-End Tests with [Cypress](https://www.cypress.io/)
```sh
bun test:e2e:dev
```
This runs the end-to-end tests against the Vite development server.
It is much faster than the production build.
But it's still recommended to test the production build with `test:e2e` before deploying (e.g. in CI environments):
```sh
bun build
bun test:e2e
```
### Lint with [ESLint](https://eslint.org/)
```sh
bun lint
```