diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000000000000000000000000000000000..24b82b38c8b1c5a7a98a2e204b0527d0ce87a455 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## Unreleased + +* Imported CLI along with development template from sib-manager project diff --git a/docs/howto_use_client_beta.md b/docs/howto_use_client_beta.md new file mode 100644 index 0000000000000000000000000000000000000000..5e206951031b4d8b245f6eace035c5cf2fa1590c --- /dev/null +++ b/docs/howto_use_client_beta.md @@ -0,0 +1,27 @@ +# How to use the client in beta + +`/!\` The client only works for development projects. + +Install the appropriate version of the client: +``` +$ python -m pip install 'git+https://git.startinblox.com/djangoldp-packages/djangoldp.git@v0.7.dev1' +``` + +Setup a new project: +``` +$ djangoldp startproject myproject +$ cd myproject +``` + +Configure the `config.yml` with the dependencies and the LDP packages your server need to serve. + +Install the server: +``` +$ djangoldp install +$ djangoldp configure +``` + +Run it: +``` +$ djangoldp runserver +``` diff --git a/docs/testing_client.md b/docs/testing_client.md new file mode 100644 index 0000000000000000000000000000000000000000..c81be89fae5e3f4211e03d0753c164e66a4c035f --- /dev/null +++ b/docs/testing_client.md @@ -0,0 +1,29 @@ +# Testing the client in docker + +## With SQLite backend + +Setup the project: +``` +# docker run --rm -v $PWD:/code -w /code -p 127.0.0.1:8000:8000 -it python:3.6 bash +# pip install . +# cd /tmp/ +# djangoldp startproject myproject +# cd myproject +# djangoldp install +# djangoldp configure +``` + +Play with it: +``` +# djangoldp runserver +``` + +## With PostgreSQL backend + +``` +# docker network create sib +# docker run --rm --network sib --name postgres -e POSTGRES_DB=sib -e POSTGRES_USER=sib -e POSTGRES_PASSWORD=test -d postgres +# docker run --rm --network sib -p 127.0.0.1:80:8000 -v $PWD:/code -it happydev1/sib:3.6 bash +# pip install --user -e .[dev] +# bash tests/integration/run_test.sh +``` diff --git a/docs/using_client.md b/docs/using_client.md deleted file mode 100644 index 0b75d685beb1559f82d28138d0582d41e2d65350..0000000000000000000000000000000000000000 --- a/docs/using_client.md +++ /dev/null @@ -1,17 +0,0 @@ -# Using the client - -Setup the project: -``` -# docker run --rm -v $PWD:/code -w /code -p 127.0.0.1:8000:8000 -it python:3.6 bash -# pip install . -# cd /tmp/ -# djangoldp startproject myproject -# cd myproject -# djangoldp install -# djangoldp configure -``` - -Play with it: -``` -# djangoldp runserver -```