inventaire/inventaire
3
9
Fork 1
Code Issues 224 Pull requests 11 Activity

Update links from github.com to codeberg.org

Browse source 
- Screenshot haven't been found so can't be updated
This commit is contained in:
Antonin Del Fabbro 2025-06-07 23:56:09 +02:00 • committed by jums
parent 0cf03660b3
commit 112bf3312c
1 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -16,7 +16,7 @@ Inventaire is a libre/open webapp to make inventories and lists of books, powere
This repository hosts the server-side code of the [Inventaire association](https://wiki.inventaire.io/wiki/Association), a collaborative resources mapper project, while yet only focused on exploring books mapping with [Wikidata](https://wikidata.org/) and [ISBNs](https://en.wikipedia.org/wiki/International_Standard_Book_Number). The flagship instance is https://inventaire.io and anyone may [create their own federated instance](https://git.inventaire.io/inventaire/src/branch/main/docs).
This repository tracks server-side developments, while the (heavy) [client-side can be found here](https://github.com/inventaire/inventaire-client). 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 [chat](https://wiki.inventaire.io/wiki/Communication_channels#Chat).
This repository tracks server-side developments, while the (heavy) [client-side can be found here](https://codeberg.org/inventaire/inventaire-client). 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 [chat](https://wiki.inventaire.io/wiki/Communication_channels#Chat).
## Summary
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
@ -68,7 +68,7 @@ For packages that need a more elaborated installation, see their own documentati
* [Install CouchDB](https://docs.couchdb.org/en/stable/install/unix.html)
* [Install ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html)
Alternatively, CouchDB and Elasticsearch could be run in Docker, see [docker-inventaire](https://github.com/inventaire/docker-inventaire)
Alternatively, CouchDB and Elasticsearch could be run in Docker, see [docker-inventaire](https://codeberg.org/inventaire/docker-inventaire)
Whatever the way you installed CouchDB and Elasticsearch, you should now be able to get a response from them:
```sh
@ -80,7 +80,7 @@ curl http://localhost:9200
### Project development environment installation
```sh
git clone https://github.com/inventaire/inventaire.git
git clone https://codeberg.org/inventaire/inventaire.git
cd inventaire
npm install --global tsx
npm install
@ -88,8 +88,8 @@ npm install
This should have installed:
- the server (this git repository) in the current directory
- the client ([inventaire-client](https://github.com/inventaire/inventaire-client)) in the `client` directory
- i18n strings ([inventaire-i18n](https://github.com/inventaire/inventaire-i18n)) in the `inventaire-i18n` directory
- the client ([inventaire-client](https://codeberg.org/inventaire/inventaire-client)) in the `client` directory
- i18n strings ([inventaire-i18n](https://codeberg.org/inventaire/inventaire-i18n)) in the `inventaire-i18n` directory
#### server
@ -112,7 +112,7 @@ Note that, while convenient, debugging emails in the browser is quite an approxi
#### client
If you want to work on the [client](https://github.com/inventaire/inventaire-client), you need to start the webpack watcher and dev server (on port `3005` by default)
If you want to work on the [client](https://codeberg.org/inventaire/inventaire-client), you need to start the webpack watcher and dev server (on port `3005` by default)
```sh
# In another terminal
cd inventaire/client
@ -124,22 +124,22 @@ npm run watch
### Repositories and Branches
#### [server](https://github.com/inventaire/inventaire)
- [**main**](https://github.com/inventaire/inventaire/src/branch/main): the stable branch. Unstable work should happen in feature-specific branches and trigger pull requests when ready to be merged in the main branch. See [Code Contributor Guidelines](https://github.com/inventaire/inventaire/wiki/Code-Contributor-Guidelines).
#### [server](https://codeberg.org/inventaire/inventaire)
- [**main**](https://codeberg.org/inventaire/inventaire/src/branch/main): the stable branch. Unstable work should happen in feature-specific branches and trigger pull requests when ready to be merged in the main branch. See [Code Contributor Guidelines](https://github.com/inventaire/inventaire/wiki/Code-Contributor-Guidelines).
#### [client](https://github.com/inventaire/inventaire-client)
- [**main**](https://github.com/inventaire/inventaire-client/src/branch/main): the stable branch. Unstable work should happen in feature-specific branches and trigger pull requests when ready to be merged in the main branch. See [Code Contributor Guidelines](https://github.com/inventaire/inventaire/wiki/Code-Contributor-Guidelines).
#### [client](https://codeberg.org/inventaire/inventaire-client)
- [**main**](https://codeberg.org/inventaire/inventaire-client/src/branch/main): the stable branch. Unstable work should happen in feature-specific branches and trigger pull requests when ready to be merged in the main branch. See [Code Contributor Guidelines](https://github.com/inventaire/inventaire/wiki/Code-Contributor-Guidelines).
#### [i18n](https://github.com/inventaire/inventaire-i18n)
#### [i18n](https://codeberg.org/inventaire/inventaire-i18n)
The repository tracking strings used in the server (for emails, activitypub) and client (for the web UI) in all the supported languages. To contribute to translations, see the [Inventaire Weblate project](https://weblate.framasoft.org/engage/inventaire/)
- [**main**](https://github.com/inventaire/inventaire-i18n/src/branch/main): tracking translations fetched from [Weblate](https://weblate.framasoft.org/engage/inventaire/) and build scripts
- [**main**](https://codeberg.org/inventaire/inventaire-i18n/src/branch/main): tracking translations fetched from [Weblate](https://weblate.framasoft.org/engage/inventaire/) and build scripts
#### [deploy](https://github.com/inventaire/inventaire-deploy)
#### [deploy](https://codeberg.org/inventaire/inventaire-deploy)
tracking installation scripts to run inventaire in production (for production documentation, see [docs](https://git.inventaire.io/inventaire/src/branch/main/docs))
- [**main**](https://github.com/inventaire/inventaire-deploy/src/branch/main): the main implementation for Debian/Ubuntu systems. Additional branches can be started to document installation on other environments
- [**main**](https://codeberg.org/inventaire/inventaire-deploy/src/branch/main): the main implementation for Debian/Ubuntu systems. Additional branches can be started to document installation on other environments
#### [docker](https://github.com/inventaire/docker-inventaire)
- [**main**](https://github.com/inventaire/docker-inventaire/src/branch/main): tracking docker installation files
#### [docker](https://codeberg.org/inventaire/docker-inventaire)
- [**main**](https://codeberg.org/inventaire/docker-inventaire/src/branch/main): tracking docker installation files
## Stack Map
This repository correspond to the the "Server" section in the [stack map](https://inventaire.github.io/stack/)