Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 1.94 KB

README.md

File metadata and controls

76 lines (48 loc) · 1.94 KB

Meta Storage Koa Gateway

Introduction

Feature

  • IPFS
    • Fleek Storage
  • JWT Auth
    • Cookie
    • Authorization header as bearer token

Development

Running

$ yarn start
# watch mode
$ yarn start:dev
# production environment
$ yarn start:prod

Coding Style

ESLint + Prettier + Lint staged + Editorconfig

$ yarn format

Conventional Commits

This project is following commitlint rules and checks the commit message with husky. You can also follow the Local setup installation guide to install this lint in your project, like following:

# Install and configure if needed
yarn add -D @commitlint/{cli,config-conventional}
echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

# Active hooks
npx husky install
# or
yarn husky install

# Add hook
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'
# or
yarn husky add .husky/commit-msg 'yarn commitlint --edit $1'

Deployment

Environment

Environment file: .env.${NODE_ENV}

Environments:

  • dev
  • test
  • prod

Check .env.example

Hosts

Vercel

Deploy with Vercel