diff --git a/README.md b/README.md index d65723a..1a75f30 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,18 @@ Shortenit is a tool to shorten urls. **NOTE**: This is a very early draft project. Contributions are welcome. +## Install + +To install `shortenit` and all of its dependencies for development, run the following script. + +``` shell +$ scripts/install.sh +``` + ## Running -To run `shortenit`, edit the configuration file found in [config/config.yaml](config/config.yaml) then run the following commands. +To run `shortenit` for development, edit the configuration file found in [config/config.yaml](config/config.yaml) then run the following script. ```text -$ pip install -e . -$ shortenit +$ scripts/run.sh ``` diff --git a/scripts/install.sh b/scripts/install.sh new file mode 100755 index 0000000..0ad942e --- /dev/null +++ b/scripts/install.sh @@ -0,0 +1,7 @@ +#!/bin/bash + +cd frontend +npm install + +cd .. +poetry install diff --git a/scripts/run.sh b/scripts/run.sh new file mode 100755 index 0000000..2864606 --- /dev/null +++ b/scripts/run.sh @@ -0,0 +1,6 @@ +#!/bin/bash + +cd frontend +npm run build +cd .. +poetry run shortenit