negodiy/docker-inventaire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme: document how to start working on the client

Browse Source
This commit is contained in:
maxlath
2023-04-28 11:53:15 +02:00
parent a1220581ad
commit 5c37c9d7a4
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -10,11 +10,10 @@ Used only for testing and development purposes, so use in production at your own
```sh
git clone https://github.com/inventaire/docker-inventaire.git
cd docker-inventaire
```
got to `cd docker-inventaire`
clone `inventaire` core application server -> [setup](https://github.com/inventaire/inventaire#installation)
Clone `inventaire` core application [server](https://github.com/inventaire/inventaire)
```sh
git clone https://github.com/inventaire/inventaire.git
@@ -26,7 +25,7 @@ Build
docker-compose build
```
Download Node dependencies:
Download Node dependencies and install the [client repository](https://github.com/inventaire/inventaire-client):
```sh
docker-compose run --rm inventaire npm install
@@ -48,10 +47,17 @@ NB: Those username and password should match the `COUCHDB_USER` and `COUCHDB_PAS
## Usage
Start CouchDB, Elasticsearch, and the Inventaire [server](https://github.com/inventaire/inventaire) in development mode (modifications to the server files will reload the server), by default on port 3006
```sh
docker-compose up -d
```
To also work on the [client](https://github.com/inventaire/inventaire-client), you need to also start the webpack dev server:
```sh
cd inventaire/client
npm run watch
```
## Create a user admin
A user admin is not that useful in development, it only allows you to merge/delete entities, see any user contributions, and a few more things. But if needed, start by signing up a user :