KRochaS/api-rest-nodejs

Bootcamp Ignite NodeJS - Rocketseat

📊 About

Project developed in the Node.js specialization bootcamp at Rocketseat, where the objective was to create a financial transactions application

📚 Technologies e libs

• NodeJS

• Typescript

• Fastify

• Knex

  💻 Routes

POST /transactions

Create a new transaction.

Request body

{
  "title": "Freelancer",
  "amount": 9000,
  "type": "credit"
}

GET /transactions

Return an array of transactions.

Response body

{
  "transactions": [
    {
      "id": "4e563c29-6b32-444f-95a8-82e546ad6b66",
      "title": "Freelancer",
      "amount": 9000,
      "created_at": "2024-04-27 20:51:57",
      "session_id": "7df05094-755f-48d2-86c0-46169d511a5b"
    }
  ]
}

GET /transactions/:transactionId

Return data from a single transaction.

Response body

{
  "transaction": {
    "id": "4e563c29-6b32-444f-95a8-82e546ad6b66",
    "title": "Freelancer",
    "amount": 9000,
    "created_at": "2024-04-27 20:51:57",
    "session_id": "7df05094-755f-48d2-86c0-46169d511a5b"
  }
}
}

GET transactions/summary

Return sumary from transaction.

Response body

{
  "summary": {
    "amount": 9000
  }
}

📝 How to run the project

#  Clone this repository.
$ git clone https://github.com/KRochaS/api-rest-nodejs.git

# Navigate to the project folder in the terminal/cmd.
$ cd api-rest-nodejs/

# Install the dependencies.
$ npm i ou yarn install

# Copy .env.example to .env file

# run the project
$ npm run dev

# HTTP server running on http://localhost:3333