Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
forever8896 committed Oct 24, 2024
0 parents commit 672c2b5
Show file tree
Hide file tree
Showing 91 changed files with 9,889 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.DS_Store
node_modules
/build
/.svelte-kit
/package
.env
.env.*
!.env.example
vite.config.js.timestamp-*
vite.config.ts.timestamp-*
7 changes: 7 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"recommendations": [
"svelte.svelte-vscode",
"tauri-apps.tauri-vscode",
"rust-lang.rust-analyzer"
]
}
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"svelte.enable-ts-plugin": true
}
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Crypto Alerts Tauri App

This is a Tauri application for receiving crypto price alerts, built with Svelte and Vite, Built from the create-tauri-app command. With the 7th chapter of the rust book read, I wanted to jump in and build something.

## Features

- Fetching of crypto prices from the Binance public websocket API
- Real-time crypto price alerts based on set prices.
- A couple fun sounds to choose from.

## Installation

1. Clone the repository:

```bash
git clone https://github.com/yourusername/crypto-alerts-tauri.git
cd crypto-alerts-tauri
```

2. Install dependencies:

```bash
npm install
```

3. Build the application:

```bash
npm run tauri build
```

4. Find the executable in the `src-tauri/target/release` directory.

## Usage

Run the executable found in `src-tauri/target/release` to start the application.

## Notes

Currently it only works on desktop, But I chose Tauri with the vision of making it cross platform in the future.


## Recommended IDE Setup

[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer).

## Contributing

Feel free to open issues or submit pull requests for improvements and bug fixes.
19 changes: 19 additions & 0 deletions jsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"extends": "./.svelte-kit/tsconfig.json",
"compilerOptions": {
"allowJs": true,
"checkJs": true,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"resolveJsonModule": true,
"skipLibCheck": true,
"sourceMap": true,
"strict": true,
"moduleResolution": "bundler"
}
// Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias
// except $lib which is handled by https://kit.svelte.dev/docs/configuration#files
//
// If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
// from the referenced tsconfig.json - TypeScript does not merge them in
}
Loading

0 comments on commit 672c2b5

Please sign in to comment.