chore(#8): Adds scripts to install, build and run the project
This commit is contained in:
parent
e727c7ca17
commit
a305ea9388
3 changed files with 23 additions and 3 deletions
13
README.md
13
README.md
|
@ -4,11 +4,18 @@ Shortenit is a tool to shorten urls.
|
||||||
|
|
||||||
**NOTE**: This is a very early draft project. Contributions are welcome.
|
**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
|
## 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
|
```text
|
||||||
$ pip install -e .
|
$ scripts/run.sh
|
||||||
$ shortenit
|
|
||||||
```
|
```
|
||||||
|
|
7
scripts/install.sh
Executable file
7
scripts/install.sh
Executable file
|
@ -0,0 +1,7 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
cd frontend
|
||||||
|
npm install
|
||||||
|
|
||||||
|
cd ..
|
||||||
|
poetry install
|
6
scripts/run.sh
Executable file
6
scripts/run.sh
Executable file
|
@ -0,0 +1,6 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
cd frontend
|
||||||
|
npm run build
|
||||||
|
cd ..
|
||||||
|
poetry run shortenit
|
Loading…
Reference in a new issue