Skip to content

Commit

Permalink
chore: docs improv header
Browse files Browse the repository at this point in the history
  • Loading branch information
DesmondSanctity committed Jun 22, 2024
1 parent 8f91b56 commit 0e0c0c2
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 23 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
### tyche-nomisma
An AI tool that you can use to get currency pair update via Whatsapp. Built with [Hono.js](https://hono.dev/), Twilio(serverless functions & whatsapp) and Cloudflare Workers AI.

### prerequisite to run project
- Cloudflare account(with your terminal authenticated with wrangler CLI) [Read more here](https://developers.cloudflare.com/workers/wrangler/commands/#login)
Expand All @@ -16,14 +17,14 @@ CLOUDFLARE_ACCOUNT_ID = ""
TWILIO_PHONE_NUMBER = ""
```

### step 2
### step 2 (run locally)
- run the following commands to install dependencies and start the dev server respectively.
```bash
npm install
npm run dev
```

### step 3
### step 3 (deploy to prod)
- you should store your secret to cloudflare workers for production use using the command below. where key is the secret name eg: CLOUDFLARE_API_KEY
```bash
npx wrangler secret put <KEY>
Expand Down
20 changes: 0 additions & 20 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
"@twind/core": "^1.1.3",
"@twind/preset-tailwind": "^1.1.4",
"hono": "^4.4.7",
"node-cron": "^3.0.3",
"openai": "^4.52.0"
},
"devDependencies": {
Expand Down

0 comments on commit 0e0c0c2

Please sign in to comment.