Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exprays/rocket
A lightning-fast search API built using Hono
https://github.com/exprays/rocket
cloudflare-workers honojs nextjs redis sorted-sets
Last synced: 27 days ago
JSON representation
A lightning-fast search API built using Hono
- Host: GitHub
- URL: https://github.com/exprays/rocket
- Owner: exprays
- Created: 2024-06-03T14:25:59.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-06T13:26:03.000Z (7 months ago)
- Last Synced: 2024-10-25T10:36:45.620Z (3 months ago)
- Topics: cloudflare-workers, honojs, nextjs, redis, sorted-sets
- Language: TypeScript
- Homepage: https://rocket-snowy.vercel.app
- Size: 226 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rocket 🚀
A Typesafe, lightning-fast, high-performance API built using Hono and cloudflare workers which searches countries in milliseconds.
It uses distriuted databases and cloudflare workers to provide superfast query messages throughout the world with the help of upstash. You can also switch database options between Redis & Serverless PostgreSQL.
## API Reference
#### Get all items
```bash
GET /api/search
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `query` | `string[]` | **Required**. Country name to search |
| `source` | `redis` or `postgres` | Database to use |
## Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`UPSTASH_REDIS_URL` - Your upstash redis database url
`UPSTASH_REDIS_TOKEN` - Your upstash redis token
`NEON_POSTGRES_URL` - Your postgreSQL database url string ( For this I used NeonDB )
## Run Locally
Clone the project
```bash
git clone https://github.com/rayxlab/rocket.git
```
Go to the project directory
```bash
cd rocket
```
Install dependencies
```bash
npm install or pnpm install
```
Start the server
```bash
npm run dev or pnpm dev
```
## Deployment
To deploy this project run
```bash
npm run deploy
```
**Note**: To deploy this project to cloudflare workers you have to add this wrangler.toml file to your root directory before deploying.
```toml
name = "rocket"
compatibility_date = "2024-04-02"
[vars]
UPSTASH_REDIS_URL="Your_redis_url"
UPSTASH_REDIS_TOKEN="Your_redis_token"
NEON_POSTGRES_URL="Your postgreSQL url"
```
## Features
- Fast searches
- Shows duration of searches
- Uses full-text RediSearch©️ algorithm
- Uses superfast serverless postgreSQL search
- Database switching
## License
[MIT](https://choosealicense.com/licenses/mit/)
# đź’» Tech Used:
     