chore(#8): Adds scripts to install, build and run the project

This commit is contained in:
Elia el Lazkani 2024-12-23 23:55:09 +01:00
parent e727c7ca17
commit a305ea9388
3 changed files with 23 additions and 3 deletions

View file

@ -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
```

7
scripts/install.sh Executable file
View file

@ -0,0 +1,7 @@
#!/bin/bash
cd frontend
npm install
cd ..
poetry install

6
scripts/run.sh Executable file
View file

@ -0,0 +1,6 @@
#!/bin/bash
cd frontend
npm run build
cd ..
poetry run shortenit