Inventaire
- 0 ratings
Collaborative resources mapper project, while yet only focused on exploring books mapping with wikidata and ISBNs.
Deploy this app to Linode with a free $100 credit!
Libre collaborative resource mapper powered by open-knowledge
This repository hosts Inventaire.io source code. Its a collaborative resources mapper project, while yet only focused on exploring books mapping with wikidata and ISBNs
This repository tracks the server-side developments, while the (heavy) client-side can be found here. Client-related technical issues should go in the client repo, while this repo gathers all other technical issues. Non-technical discussions such as feature requests should preferably happen in the roadmap. In doubt, just use your best guess or come ask on the chat :)
This is the installation documentation for a developement environment. For production setup, see: inventaire-deploy
To install all this those dependencies on Ubuntu 20.04:
For packages available in Ubuntu default repositories:
sudo apt-get update
sudo apt-get install git curl wget graphicsmagick inotify-toolsAlternatively, CouchDB and Elasticsearch could be run in Docker:
* Install docker and docker-compose
* Get the docker-compose.yml:
wget https://raw.githubusercontent.com/inventaire/docker-inventaire/master/docker-compose.ymlcouchdb and elasticsearch services in the background:
docker-compose up -d couchdb elasticsearchWhatever the way you installed CouchDB and Elasticsearch, you should now be able to get a response from them:
# Verify that CouchDB is up
curl http://localhost:5984
# Verify that Elasticsearch is up
curl http://localhost:9200git clone https://github.com/inventaire/inventaire.git
cd inventaire
npm installThis should have installed:
- the server (this git repository) in the current directory
- the client (inventaire-client) in the client directory
- i18n strings (inventaire-i18n) in the inventaire-i18n directory
The installation step above should have triggered the creation of a ./config/local.js file, in which you can override all present in ./config/default.js: make sure to set db username and password to your CouchDB username and password.
And now you should be all set! You can now start the server (on port 3006 by default)
# Starting the server in watch mode so that it reboots on file changes
npm run watchTo debug emails in the browser:
* Get some username and password at https://ethereal.email/create and set the following values in config: mailer.nodemailer.user and mailer.nodemailer.pass.
* Make an action that triggers the email you would like to work on on the local server (ex: send a friend request)
* Open https://ethereal.email/messages to see the generated email
Note that, while convenient, debugging emails in the browser is quite an approximation, as some email clients are antiquated, and, sadly, modern CSS can't be used.
If you want to work on the client, you need to start the webpack watcher and dev server (on port 3005 by default)
# In another terminal
cd inventaire/client
npm run watchmocha), you can either find them in ./node_modules/.bin or install them globally with npm: npm install -g mocha supervisor lev2 etc.the repo tracking strings used in the client and emails in all the supported languages. For helping to translate, see translate.inventaire.io - master: tracking translations fetched from the translation tool and build scripts - dist: same as master but with pre-built files
tracking installation scripts and documentation to run inventaire in production - master: the main implementation targeting Ubuntu 16.04. Additional branches can be started to document installation on other environments
This repo correspond to the the "Server" section in the stack map
the app has a few core concepts: - Users - Entities : which can be authors (ex: wd:Q353), books (ex: wd:Q393018) and books' specific editions (ex: isbn:9782070389162). The term entities comes from wikidata terminology. See the entities map. - Items : instances of book entities that a user says they have. It can be an instance of a work or a specific edition of a work. - Transactions : discussion between two users about a specific item with an open transaction mode (giving, lending, selling). Transactions have effects on items: giving and selling an item make it move from the owner to the requester inventory; lending an item shows it as unavailable. - Groups: groups of users with one or more admins
For code-related contributions, see How to contribute on wiki.inventaire.io.
see docs
see wiki.inventaire.io You may want to directly go to the technical wiki page
see wiki: API
see Administration
Inventaire is an open-sourced project licensed under AGPLv3.
Please login to review this project.
No reviews for this project yet.
Open source, expandable Business Management Software. Manag…
Free, self-hosted, open-source, envelope-budgeting web and …
Firefly III is a modern financial manager. It helps you to …
Comments (0)
Please login to join the discussion on this project.