Skip to content

Commit

Permalink
docs: update documentation and screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
raimund-schluessler committed Feb 3, 2024
1 parent 8af9ceb commit c34fd5d
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,31 @@

## Features

* edit items
- List all items and their properties in your inventory
- Sort items into folders or places
- Link parent, related and sub items
- Upload attachments such as invoices and manuals
- Upload images for items
- Find item instances by their storage place
- Assign unique UUIDs and find item instances by scanning their GTIN or QR code
- Assign tags to items and search by tag

## Developer setup info
## Build the app

Just clone this repo into your apps directory (Nextcloud server installation needed). Additionally, [nodejs and npm](https://nodejs.org/en/download/package-manager/) are needed for installing JavaScript dependencies.
To build you need to have [Node.js](https://nodejs.org/en/) installed.

Once node and npm are installed, PHP and JavaScript dependencies can be installed by running
```bash
$ make
- Install JS dependencies: `npm ci`
- Build JavaScript for the frontend
- `npm run dev` development build
- `npm run watch` watch for changes
- `npm run build` production build

Read more about [necessary prerequisites](https://docs.nextcloud.com/server/latest/admin_manual/installation/source_installation.html#prerequisites-for-manual-installation) for manual installs.

## Running tests

You can run the front-end tests by using:

```
npm run test
```
Please execute this command with your ordinary user account and neither root nor sudo.
Binary file modified screenshots/inventory-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/inventory-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c34fd5d

Please sign in to comment.