JefferyHus / tatogami

A plug and play API to easily build your own portfolio

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Tatogami (beta)

A plug and play CMS like portfolio API for quickly building a custom portfolio without the headaches of maintaning your static data.

Description

The idea behind this project is to provide you with a secure and easy to use API that can go with any frontend template.

Installation

# clone the project
$ git clone https://github.com/JefferyHus/tatogami.git

# create an env file using the existing template
$ cp .env.configuration .env

Running the API

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Todo

  • Add api access keys
  • Add refresh token logic
  • Add tests (unit, integration)

About

A plug and play API to easily build your own portfolio


Languages

Language:TypeScript 98.6%Language:JavaScript 1.2%Language:Dockerfile 0.2%