/valexAPI

TypeScript project of a benefits card API. The API will be responsible for creating, recharging, as well as processing purchases. 🍕

Primary LanguageTypeScript

🍕 Valex 🍕

Valex 🚀 Complete

AboutFeaturesHow it worksTech StackAuthor

About

TypeScript project of a benefits card API. The API will be responsible for creating, recharging, as well as processing purchases. 🍕


Features

  • Card creation
  • Card activation
  • Viewing balance and transactions of a Card
  • Card Recharge
  • Purchases in Points of Sale using the Card

How it works

This project is a Backend project amde with TypeScript, run it using npm or yarn.

Pre-requisites

Before you begin, you will need to have the following tools installed on your machine: [Git] (https://git-scm.com), [Node.js] (https://nodejs.org/en/). In addition, it is good to have an editor to work with the code like [VSCode] (https://code.visualstudio.com/)

Runnig the backend (server)

# Clone this repository
$ git clone git@github.com:neves-gabriel/valexAPI.git

# Access the project folder cmd/terminal
$ cd valexAPI

# install the dependencies
$ npm install

# Run the application in development mode
$ npm run dev

# The server will start at port: 5000 - go to http://localhost:5000

Tech Stack

The following tools were used in the construction of the project:

Server (NodeJS)

See the file package.json


Author

Gabriel Neves
Gabriel Neves

Gmail Badge