https://github.com/nielse63/alpaca-firebase
Firebase implementation for running Alpaca scripts
https://github.com/nielse63/alpaca-firebase
Last synced: about 1 month ago
JSON representation
Firebase implementation for running Alpaca scripts
- Host: GitHub
- URL: https://github.com/nielse63/alpaca-firebase
- Owner: nielse63
- Created: 2024-07-28T10:52:38.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-19T07:17:43.000Z (8 months ago)
- Last Synced: 2024-10-12T17:42:25.204Z (7 months ago)
- Language: JavaScript
- Size: 3.01 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# alpaca-firebase
> Algotrading bot example using TypeScript
[Learn how to create your first algotrading bot on Medium.](https://medium.com/@ErikKyleNielsen/write-your-first-typescript-algotrading-bot-8194dfe60e5f)
## Prerequisites
Node `v22.12.0` and a global installation of `firebase-tools` are required to work on this project:
```bash
nvm install v22.12.0
npm i -g firebase-tools
```
## Installation
```bash
git clone https://github.com/nielse63/alpaca-firebase.git
cd alpaca-firebase
nvm use
npm ci
```
## Usage
| Command | Description |
| ---------------- | ---------------------------------- |
| `npm run serve` | Run the firebase functions locally |
| `npm run deploy` | Deploy functions to production |
### Development
| Command | Description |
| --------------- | ------------------------------- |
| `npm run lint` | Lint and format source files |
| `npm run build` | Generate type declaration files |
### Testing
```bash
npm test
# with coverage
npm test -- --coverage
```
### Creating a new release
```bash
npm run release
npm run release -- --patch # release patch version
npm run release -- --minor # release minor version
npm run release -- --major # release major version
npm run release -- --force # run even with uncommitted changes
npm run release -- --dry-ryn # don't create an npm release
```