Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gustavohps10/transactions-api
🎲 API REST - credit and debit transactions
https://github.com/gustavohps10/transactions-api
fastify knex nodejs rest-api sqlite typescript vitest zod
Last synced: 23 days ago
JSON representation
🎲 API REST - credit and debit transactions
- Host: GitHub
- URL: https://github.com/gustavohps10/transactions-api
- Owner: Gustavohps10
- License: apache-2.0
- Created: 2024-05-28T00:27:39.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-06T03:07:19.000Z (5 months ago)
- Last Synced: 2024-10-11T19:22:08.566Z (about 1 month ago)
- Topics: fastify, knex, nodejs, rest-api, sqlite, typescript, vitest, zod
- Language: TypeScript
- Homepage: https://transactions-api-d9kj.onrender.com/
- Size: 135 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Transactions REST API
## :camera: Screenshot
## :page_with_curl: Description
A simple API that allows the user to carry out credit and debit transactions
## :pushpin: Endpoints
```
POST /transactions
GET /transactions
GET /transactions/:id
GET /transactions/summary
```
## :gear: Running the App
### :globe_with_meridians: Web
You can access this url: https://transactions-api-d9kj.onrender.com if it is still working ¯\\_(ツ)_/¯
### :computer: Local
First fork and clone this repo. Feel free to create new pull requests
#### Environment
Rename .env.example to .env and set variables
```
NODE_ENV=development
DATABASE_CLIENT=sqlite
DATABASE_URL="./db/app.db"
HOST=localhost
PORT=3333
```
#### Install dependencies
```
npm install
```
#### Migrate database
```
npm run knex migrate:latest
```
#### Run server
```
npm run dev
```
#### Test
```
npm test
```
## :hammer_and_wrench: Tools
## :adult: Contributors
[](#contributors)
