Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #125

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41954d4
Update README.md
0xCAB0 Nov 4, 2024
0a0e8d3
Update README.md
0xCAB0 Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ vinted-rs = { version = "0.10.0",

### Advanced filters

> This feature requires [setting up a Postgres Database](#database-set-up) <code><img width="3%" src="https://raw.githubusercontent.com/yurijserrano/Github-Profile-Readme-Logos/refs/heads/master/databases/postgresql.svg"></code>
> [!NOTE]
> This feature requires [setting up a Postgres Database](#database-set-up) <code><img width="3%" src="https://raw.githubusercontent.com/yurijserrano/Github-Profile-Readme-Logos/refs/heads/master/databases/postgresql.svg"></code>

Uses the data pulled by the [scrapping module](./scrapping/vinted-db-feeder/), which is stored in the diesel [migrations](./migrations/) folder.

Expand All @@ -47,7 +48,8 @@ Uses the data pulled by the [scrapping module](./scrapping/vinted-db-feeder/), w
#### Database set-up
Advanced filtering features must require this setup before running.

1. ⚠️ `diesel-cli` installation may fail if you do not have `libpq` library installed. To install `libpq`, just install PostgreSQL package on your machine.
> [!IMPORTANT]
`diesel-cli` installation may fail if you do not have `libpq` library installed. To install `libpq`, just install PostgreSQL package on your machine.

- In `Arch` based is only necessary to install this package.

Expand Down Expand Up @@ -100,18 +102,18 @@ Advanced filtering features must require this setup before running.

#### Testing set-up

> [!NOTE]
> This step requires completing the [DB setup](#database-set-up)

```bash
cargo test
```

### Redis

This feature allows recovered results to be cached using a Redis instance. <code><img width="4%" src="https://raw.githubusercontent.com/yurijserrano/Github-Profile-Readme-Logos/refs/heads/master/databases/redis.svg"></code>

A development instance can be created using:

```bash
make cache
```
```
Loading