gone.bike

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #go #docker #nodejs #java #awesome #cli #kubernetes #vue #openai #open-source

(★ 18)

Global stolen bikes db & search engine

gone.bike Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Gone.Bike
OpenSource, OpenData stolen bikes database, search engine and reporting tool.

Data is publicly accessible at [gone.bike/exports/](https://gone.bike/exports/)

## Project Goals
Create a global database of stolen bikes that can easily be accessed and searched,
in order to provide a fast, efficient and effective way to identify suspicious bikes
(from second hand markets, online ads, etc), using image search features and dynamic filters for a quick match.

## Features
- Receive direct reports via a detailed form (done)
- Collect and index reports from various public, local websites (WIP)
- Image search (WIP)
- Filtering search (WIP)
- Threaded discussions (TODO)
- Theft Heatmap (ROADMAP)

### Use cases
- You want to buy a second hand bike (flea market, online): you can search the db to check if the bike has been reported.
- You spot a suspicious bike and you match it in the datbase: you can report it
- Police force find stolen bikes and they can use the db to identify the owner

### Motivations
Whether you're a seasoned cyclist, a daily traveler, or an aspiring rider, you should know this feeling about bikes: they are not just things,
they are objects, yes, but we create a relationship with them. They carry us, they share sweat and tears with us and they are loyal companions that contribute to make the world a better place, reducing both noise and pollution, improving our health and mood.

Having your bike stolen is not just a monetary blow, but a personal hit to a "member" of your life, almost a friend.
The feeling of powerlessness afterwards, knowing how little you can do to recover it, thinking that your wheeled buddy is somewhere out there is frustrating.

Supported by technology, the frustation can be funneled into a good activity, beign a vigilant watcher, on the lookout to fight thieves back.

## Tech Stack
- [Astro](https://astro.build) / [VueJS](https://vuejs.org/) (Frontend)
- [Celery](https://docs.celeryq.dev/) (Backend)
- [Directus](https://directus.io) (Middleware / API)
- [Docker](https://www.docker.com/) (DevOp)
- [PostgreSQL](https://www.postgresql.org) (Backend)
- [Redis](https://redis.io) (Backend)
- [Weaviate](https://weaviate.io) (Backend)

## Dev requirements
You need to have `npm` and `docker-compose` commands available.

## Development Setup
This guide provides all necessary steps to have a fully functional local setup.

Clone this repository and access the repository root directory:

```
git clone git@github.com:gone-bike/gone.bike.git && \
cd gone.bike
```

---

### Frontend setup
Create development env file in `astro/` directory and install dependencies:

```
cd astro && \
cp .env.example .env && \
npm i
```

For pages that do not require db connection, this is enough to have the dev environment up and running, otherwise you need to have the backend setup.

Generate multilanguage pages:
```npx astro-i18next generate```

Start the local server with:
```npm run dev```

---

### Database setup

In repository root directory, use template env files:

```
touch .env && \
cp .worker.env.example .worker.env && \
cp .directus.env.example .directus.env && \
cp .astro.env.example .astro.env
```

Create local data and config folders:
```
mkdir -p .config .data/{directus,postgresql} && \
chmod 0777 .data/directus
```

Create local config folder and files:
```
touch .config/redis.conf
```

Startup `postgresql`, `redis` and `directus` services:

```
docker-compose up -d postgresql redis directus
```

Ensure server is running with:
```
docker-compose logs --tail 10 directus
```

that should show something smilar to this:
```
gone.bike.directus  | [12:35:20.420] INFO: Adding first admin user...
gone.bike.directus  | [12:35:20.483] INFO: Done
gone.bike.directus  | [12:35:23.050] INFO: Server started at http://0.0.0.0:8055
```

Reflect `DIRECTUS_TOKEN` in database (for website to access it):
```
export $(cat astro/.env | grep DIRECTUS_TOKEN | tr -d '"') && \
 docker-compose exec postgresql psql -U postgres -c "UPDATE directus_users SET token = '$DIRECTUS_TOKEN'"
```

Copy database schema inside directus container and apply it:

```
docker-compose cp database/directus-schema.yml directus:/directus/ && \
docker-compose exec directus npx directus schema apply -y directus-schema.yml
```

Verify successful schema install by accessing directus at [http://localhost:8055](http://localhost:8055) using default user and password (configurable in `.directus.env` file before first startup):

```
username: dev@gone.bike
password: dev
```

**NOTE**: It might be a directus bug, but in order to fully apply the schema and see it in the CMS, you need to perform a "Make collection invisible / Make collection visible" operation on any of the available collections. Operation can be applied twice in order to keep the state. After that, access the [/admin/settings/data-model/bike_brand](http://localhost:8055/admin/settings/data-model/bike_brand) address to enforce Directus metadata reload.

You should now be able to see a empty but schemed database.

---

### Database import

SQL database

```
wget https://gone.bike/exports/gone.bike.db-dump.latest.sql.gz && \
gunzip -c gone.bike.db-dump.latest.sql.gz | docker-compose exec -T postgresql psql -U postgres
```

Images

```
wget https://gone.bike/exports/gone.bike.images.latest.tgz  && \
tar zxvf gone.bike.images.latest.tgz --directory .data/directus/
```

### Image search setup
@TODO

gone.bike

gone.bike Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

gone.bike

gone.bike Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README