mathben/erplibre
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

[UPD] README.md: minimum dependency suggestion

Browse source
This commit is contained in:
Mathieu Benoit 2024-08-16 11:30:34 -04:00
parent 7860e902fc
commit f12b0b2903
1 changed files with 29 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,33 +1,53 @@
# ERPLibre documentation # ERPLibre documentation
Select a guide to install your environment. Select a guide to install your environment.
## Easy way to run locally ## Easy way to run locally
Into Ubuntu, minimal dependency: Into Ubuntu, minimal dependency:
```bash ```bash
sudo apt install make git sudo apt install make git curl
``` ```
Into Ubuntu, developper dependency:
```bash
sudo apt install make build-essential libssl-dev zlib1g-dev libreadline-dev libsqlite3-dev curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev liblzma-dev libbz2-dev libldap2-dev libsasl2-dev
```
Clone the project: Clone the project:
```bash ```bash
git clone https://github.com/ERPLibre/ERPLibre.git git clone https://github.com/ERPLibre/ERPLibre.git
cd ERPLibre cd ERPLibre
``` ```
Support Ubuntu 18.04, 20.04 and OSX. The installation duration is more than 30 minutes. Support Ubuntu 18.04, 20.04 and OSX. The installation duration is more than 30 minutes.
```bash ```bash
make install make install
``` ```
Update your configuration if you need to run from another interface than 127.0.0.1, file `config.conf` Update your configuration if you need to run from another interface than 127.0.0.1, file `config.conf`
``` ```
xmlrpc_interface = 0.0.0.0 xmlrpc_interface = 0.0.0.0
``` ```
Ready to execute: Ready to execute:
```bash ```bash
make run make run
``` ```
## Easy way to run docker ## Easy way to run docker
First, install dependencies to run docker, check script `./script/install/install_ubuntu_docker.sh`. You need docker and docker-compose.
First, install dependencies to run docker, check script `./script/install/install_ubuntu_docker.sh`. You need docker and
docker-compose.
The docker volume is bound to the directory name, therefore create a unique directory name and run: The docker volume is bound to the directory name, therefore create a unique directory name and run:
```bash ```bash
wget https://raw.githubusercontent.com/ERPLibre/ERPLibre/v1.5.0/docker-compose.yml wget https://raw.githubusercontent.com/ERPLibre/ERPLibre/v1.5.0/docker-compose.yml
docker compose up -d docker compose up -d
@ -36,22 +56,29 @@ docker compose up -d
For more information, read [Docker guide](./docker/README.md). For more information, read [Docker guide](./docker/README.md).
## Discover guide ## Discover guide
[Guide to run ERPLibre in discover to learn it](./doc/DISCOVER.md). [Guide to run ERPLibre in discover to learn it](./doc/DISCOVER.md).
## Production guide ## Production guide
[Guide to run ERPLibre in production server](./doc/PRODUCTION.md). [Guide to run ERPLibre in production server](./doc/PRODUCTION.md).
## Development guide ## Development guide
[Guide to run ERPLibre in development environment](./doc/DEVELOPMENT.md). [Guide to run ERPLibre in development environment](./doc/DEVELOPMENT.md).
# Execution # Execution
[Guide to run ERPLibre with different case](./doc/RUN.md). [Guide to run ERPLibre with different case](./doc/RUN.md).
# git-repo # git-repo
To change repository like addons, see [GIT_REPO.md](doc/GIT_REPO.md) To change repository like addons, see [GIT_REPO.md](doc/GIT_REPO.md)
# Test # Test
Execute ERPLibre test with his code generator. Execute ERPLibre test with his code generator.
```bash ```bash
time make test_full_fast time make test_full_fast
``` ```