https://github.com/kamil-kubiczek/expense-tracker-cli
CLI which acts as tRPC client between user and Expense Tracker API
https://github.com/kamil-kubiczek/expense-tracker-cli
cli cookies nodejs trpc-client
Last synced: 20 days ago
JSON representation
CLI which acts as tRPC client between user and Expense Tracker API
- Host: GitHub
- URL: https://github.com/kamil-kubiczek/expense-tracker-cli
- Owner: kamil-kubiczek
- Created: 2025-01-02T21:10:09.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-01-12T18:40:47.000Z (9 months ago)
- Last Synced: 2025-08-08T15:56:46.770Z (about 2 months ago)
- Topics: cli, cookies, nodejs, trpc-client
- Language: TypeScript
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## About project
CLI which acts as tRPC client for Expense Tracker API - [Expense Tracker API repository](https://github.com/kamil-kubiczek/expense-tracker-api)
Feel free to fork or inspire.
**Project status: 🟢Ready to use**
## Features
Features provided by API and exposed to user by CLI are described here - https://roadmap.sh/projects/expense-tracker-api
## Installation
1. Clone this repository
```
git clone https://github.com/kamil-kubiczek/expense-tracker-cli/
```
2. Install npm dependencies
```
npm i
```
## How to run CLI client
**Prerequisites:**
- must have `bun` installed
- must have `npm@8.19.4 or higher` installed
**Steps**
1. Download Expense Tracker API public repository - [API repository](https://github.com/kamil-kubiczek/expense-tracker-api)
1. Setup Expense Tracker API locally in development mode - [Steps to run API locally](https://github.com/kamil-kubiczek/expense-tracker-api?tab=readme-ov-file#how-to-run-api)
1. Inside `expense-tracker-api` repository use `npm link`
1. Then go to `expense-tracker-cli` folder and use `npm link expense-tracker-api`
1. Run API locally
1. Copy `.env.example` and rename to `.env`
1. Change `SERVER_URL` to url of you API
1. Run CLI using `bun run start`
**If you set up API in production mode, remember to find out which port CLI app is using and construct proper URL for API CORS. If you don't know, run API in development mode!**
---