Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 1.37 KB

README.md

File metadata and controls

60 lines (45 loc) · 1.37 KB

Token store API

An OpenSea-like backend project built with Postgres, Express and Node

Introduction

This project aims to provide users with a simple and intuitive platform for collecting, selling and buying virtual tokens with other users

Get started

Clone the repo:

git clone https://github.com/tomas-oa/token_store

Install all dependencies:

npm i

(you have to be in the root folder of the project)

Run locally

You can run the API in development mode with:

npm run dev

Or run it with node:

npm start

Swagger UI Documentation

In order to access SwaggerUI use:

localhost:PORT/api-docs

Default port is 5000

FN3 Database Schema

store-er

Some of the tech used

  • Node as runtime enviroment for JavaScript
  • Express as the backend framework
  • Postgres as the database
  • node-postgres to create connection with the database and make querys
  • Swagger UI for documentation of the API

Enviroment variables

To run this project, you'll need to add the following enviroment variables to your .env file in the root folder.

.env

DB_USER

DB_PASSWORD

DB_HOST

DB_PORT

DB_DATABASE