https://github.com/rafaelmotaalvess/transact-api
Node Rest API for financial transactions
https://github.com/rafaelmotaalvess/transact-api
e2e-tests fastify knex sqlite3 supertest tsup typescript vitest zod
Last synced: about 2 months ago
JSON representation
Node Rest API for financial transactions
- Host: GitHub
- URL: https://github.com/rafaelmotaalvess/transact-api
- Owner: RafaelMotaAlvess
- License: mit
- Created: 2023-10-28T17:12:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-30T21:31:33.000Z (over 1 year ago)
- Last Synced: 2023-10-30T23:27:47.039Z (over 1 year ago)
- Topics: e2e-tests, fastify, knex, sqlite3, supertest, tsup, typescript, vitest, zod
- Language: TypeScript
- Homepage: https://transact-api-nv3k.onrender.com
- Size: 538 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Transact API
[](https://wakatime.com/badge/user/0cca606b-99f7-4d43-8228-7f249bc17f26/project/018b774b-036e-4abc-9950-28de5d1a6f68)
> **Transact API** is a Node Rest API for credit and debit financial transactions.
## Introductions 📖
- [🔎 About](#🔎-About)
- [🔧 Technologies](#🔧-Technologies)
- [✨ How to Run](#✨-How-to-Run)
- [🚩 Endpoints](#🚩-Endpoints)
- [📃 License](#📃-License)
## 🔎 About
The project was conducted for studies on REST APIs, developed in TypeScript, and utilizing technologies like Fastify, which efficiently handles HTTP requests, Knex, which simplifies database interaction, and various other tools that assist in the development process.
- [x] The user should be able to create an transaction.
- [x] The user should be able to obtain an transaction statement.
- [x] The user should be able to list all transactions that have occurred.
- [x] The user should be able to view a single transaction.
## 🔧 Technologies
- TypeScript
- Fastify
- Knex
- Vitest
- PostgreSQL
- SQLite
- Zod
- Supertest
- Tsup
## ✨ How to Run
- ### **Prerequisites**
- It is **required** to have **Git** installed and configured on your computer.
- It is **required** to have **NodeJS** installed and configured on your computer.
#### 1. Make a clone of the repository.
```bash
$ git clone https://github.com/RafaelMotaAlvess/Transact-API.git
```
#### 2. Install the project's dependencies via the terminal.
```bash
$ npm install
```
#### 3. In the project folder, you will find a file named example.env Make a copy of it and rename it to .env
#### 4. In the project folder, you will find a file named example.env. Make a copy of it and rename it to .env
#### 5. (Optional) Add the port you desire by setting the environment variable "port."
```env
PORT= "Add the port you will use."
```
#### 6. Run the migration
```bash
npm run knex -- migrate:latest
```
#### 7. Start the server.
```bash
npm run dev
```
## 🚩 Endpoints
| Method | Description |
| --------------------------- | -------------------------- |
| `POST /transactions` | Create new transaction |
| `GET /transactions` | List all transactions |
| `GET /transactions/:id` | Get a specific transaction |
| `GET /transactions/summary` | Get the summary |
## 📃 License
The project is under the license [MIT license](./LICENSE).
---
This application was developed under the mentorship of [Rocketseat](https://www.rocketseat.com.br).