Juan Rodriguez
284 lines
7.0 KiB
Markdown
284 lines
7.0 KiB
Markdown
[](https://hub.docker.com/repository/docker/sjdonado/bit)
|
|
[](https://hub.docker.com/repository/docker/sjdonado/bit)
|
|
[](https://hub.docker.com/repository/docker/sjdonado/bit)
|
|
|
|
# Benchmark
|
|
|
|
```shell
|
|
$ ./benchmark.sh
|
|
Semaphore initialized with 2666 slots.
|
|
Setup...
|
|
[+] Running 2/2
|
|
✔ Network bit_default Created 0.0s
|
|
✔ Container bit-app-1 Started 0.2s
|
|
2024-07-12T18:41:20.962052Z INFO - micrate: Migrating db, current version: 0, target: 20240711224103
|
|
2024-07-12T18:41:20.965729Z INFO - micrate: OK 20240512214223_create_links.sql
|
|
2024-07-12T18:41:20.969198Z INFO - micrate: OK 20240512225208_add_slug_index_to_links.sql
|
|
2024-07-12T18:41:20.973136Z INFO - micrate: OK 20240513115731_create_users.sql
|
|
2024-07-12T18:41:20.975525Z INFO - micrate: OK 20240513130054_add_api_key_index_to_users.sql
|
|
2024-07-12T18:41:20.979195Z INFO - micrate: OK 20240711224103_create_clicks.sql
|
|
Captured API Key: Z01Qk4M5E0xhggZUCdQAPw
|
|
Waiting for database to be ready...
|
|
Creating 1000 short links...
|
|
Created short link 100/1000
|
|
Created short link 200/1000
|
|
Created short link 300/1000
|
|
Created short link 400/1000
|
|
Created short link 500/1000
|
|
Created short link 600/1000
|
|
Created short link 700/1000
|
|
Created short link 800/1000
|
|
Created short link 900/1000
|
|
Created short link 1000/1000
|
|
Accessing each link 10 times concurrently...
|
|
****Results****
|
|
Average Memory Usage: 16.36 MiB
|
|
Average CPU Usage: 0%
|
|
Average Response Time: 12.37 µs
|
|
```
|
|
|
|
# Self-hosted
|
|
|
|
## Run via docker-compose
|
|
|
|
```bash
|
|
docker-compose up
|
|
|
|
# Generate an api key
|
|
docker-compose exec -it app cli --create-user=Admin
|
|
```
|
|
|
|
## Run via docker cli
|
|
|
|
```bash
|
|
docker run \
|
|
--name bit \
|
|
-p 4000:4000 \
|
|
-e ENV="production" \
|
|
-e DATABASE_URL="sqlite3://./sqlite/data.db?journal_mode=wal&synchronous=normal&foreign_keys=true" \
|
|
-e APP_URL="http://localhost:4000" \
|
|
sjdonado/bit
|
|
|
|
docker exec -it bit cli --create-user=Admin
|
|
```
|
|
|
|
## Dokku
|
|
|
|
```dockerfile
|
|
FROM sjdonado/bit
|
|
```
|
|
|
|
```bash
|
|
dokku apps:create bit
|
|
|
|
dokku domains:set bit bit.donado.co
|
|
dokku letsencrypt:enable bit
|
|
|
|
dokku storage:ensure-directory bit-sqlite
|
|
dokku storage:mount bit /var/lib/dokku/data/storage/bit-sqlite:/usr/src/app/sqlite/
|
|
|
|
dokku config:set bit DATABASE_URL="sqlite3://./sqlite/data.db?journal_mode=wal&synchronous=normal&foreign_keys=true" APP_URL=https://bit.donado.co
|
|
|
|
dokku ports:add bit http:80:4000
|
|
dokku ports:add bit https:443:4000
|
|
|
|
dokku run bit cli --create-user=Admin
|
|
```
|
|
|
|
# Usage
|
|
|
|
## API Endpoints
|
|
|
|
1. **Ping the API**
|
|
|
|
- Endpoint: `GET /api/ping`
|
|
- Payload: None
|
|
- Response Example
|
|
```json
|
|
{
|
|
"message": "pong"
|
|
}
|
|
```
|
|
|
|
2. **Retrieve a link by its slug**
|
|
|
|
- Endpoint: `GET /:slug`
|
|
- Headers: `X-Api-Key`
|
|
- Payload: None
|
|
- Response Example
|
|
```json
|
|
{
|
|
"data": {
|
|
"id": "84f0c7a4-8c4e-4665-b676-cb9c5e40f1db",
|
|
"refer": "http://localhost:4000/3wP4BQ",
|
|
"origin": "https://monocuco.donado.co",
|
|
"clicks": [
|
|
{
|
|
"id": "730e2202-58f9-478c-a24c-f1c561df6716",
|
|
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:127.0) Gecko/20100101 Firefox/127.0",
|
|
"language": "en-US",
|
|
"browser": "Firefox",
|
|
"os": "Mac OS X",
|
|
"source": "Unknown",
|
|
"created_at": "2024-07-12T19:25:22Z"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
3. **Retrieve all links**
|
|
|
|
- Endpoint: `GET /api/links`
|
|
- Headers: `X-Api-Key`
|
|
- Payload: None
|
|
- Response Example
|
|
```json
|
|
{
|
|
"data": [
|
|
{
|
|
"id": "84f0c7a4-8c4e-4665-b676-cb9c5e40f1db",
|
|
"refer": "http://localhost:4000/3wP4BQ",
|
|
"origin": "https://monocuco.donado.co",
|
|
"clicks": [
|
|
{
|
|
"id": "730e2202-58f9-478c-a24c-f1c561df6716",
|
|
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:127.0) Gecko/20100101 Firefox/127.0",
|
|
"language": "en-US",
|
|
"browser": "Firefox",
|
|
"os": "Mac OS X",
|
|
"source": "Unknown",
|
|
"created_at": "2024-07-12T19:25:22Z"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
4. **Retrieve a link by its ID**
|
|
|
|
- Endpoint: `GET /api/links/:id`
|
|
- Headers: `X-Api-Key`
|
|
- Payload: None
|
|
- Response Example
|
|
```json
|
|
{
|
|
"data": {
|
|
"id": "84f0c7a4-8c4e-4665-b676-cb9c5e40f1db",
|
|
"refer": "http://localhost:4000/3wP4BQ",
|
|
"origin": "https://monocuco.donado.co",
|
|
"clicks": [
|
|
{
|
|
"id": "730e2202-58f9-478c-a24c-f1c561df6716",
|
|
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:127.0) Gecko/20100101 Firefox/127.0",
|
|
"language": "en-US",
|
|
"browser": "Firefox",
|
|
"os": "Mac OS X",
|
|
"source": "Unknown",
|
|
"created_at": "2024-07-12T19:25:22Z"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
5. **Create a new link**
|
|
|
|
- Endpoint\*\*: `POST /api/links`
|
|
- Payload:
|
|
```json
|
|
{
|
|
"url": "https://example.com"
|
|
}
|
|
```
|
|
- Headers: `X-Api-Key`
|
|
- Response Example:
|
|
```json
|
|
{
|
|
"data": {
|
|
"id": "84f0c7a4-8c4e-4665-b676-cb9c5e40f1db",
|
|
"refer": "http://localhost:4000/3wP4BQ",
|
|
"origin": "https://monocuco.donado.co/test",
|
|
"clicks": []
|
|
}
|
|
}
|
|
```
|
|
|
|
6. **Update an existing link by its ID**
|
|
|
|
- Endpoint: `PUT /api/links/:id`
|
|
- Payload:
|
|
```json
|
|
{
|
|
"url": "https://newexample.com"
|
|
}
|
|
```
|
|
- Headers: `X-Api-Key`
|
|
- Response Example:
|
|
```json
|
|
{
|
|
"data": {
|
|
"id": "84f0c7a4-8c4e-4665-b676-cb9c5e40f1db",
|
|
"refer": "http://localhost:4000/3wP4BQ",
|
|
"origin": "https://newexample.com",
|
|
"clicks": []
|
|
}
|
|
}
|
|
```
|
|
|
|
7. **Delete a link by its ID**
|
|
|
|
- Endpoint: `DELETE /api/links/:id`
|
|
- Payload: None
|
|
- Headers: `X-Api-Key`
|
|
- Response Example:
|
|
```json
|
|
{
|
|
"message": "Link deleted"
|
|
}
|
|
```
|
|
|
|
## CLI
|
|
|
|
```
|
|
Usage: ./cli [options]
|
|
Options:
|
|
--create-user=NAME Create a new user with the given name
|
|
--list-users List all users
|
|
--delete-user=USER_ID Delete a user by ID
|
|
```
|
|
|
|
# Development
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
brew tap amberframework/micrate
|
|
brew install micrate
|
|
```
|
|
|
|
```bash
|
|
shards run bit
|
|
```
|
|
|
|
## Generate the `X-Api-Key`
|
|
|
|
```bash
|
|
shards run cli -- --create-user=Admin
|
|
```
|
|
|
|
## Run tests
|
|
|
|
```bash
|
|
ENV=test crystal spec
|
|
```
|
|
|
|
## Contributing
|
|
|
|
1. Fork it (<https://github.com/sjdonado/bit/fork>)
|
|
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
4. Push to the branch (`git push origin my-new-feature`)
|
|
5. Create a new Pull Request
|