README.md

launchpad

Applied Blockchain's NodeJS Project Starter

Requirements

To build and run this app locally you will need:

• Node.js
• NPM
• YARN
• Docker

Features

• Yarn workspaces
• Lint and Prettier
• Dockerized

API

• Nodemon - server auto-restarts when code changes
• Koa v2
• TypeORM (SQL DB) with basic CRUD included
• Swagger decorator (auto generated swagger docs)
• Class-validator - Decorator based entities validation
• Jest unit tests
• Jest integration tests
• Sentry Integration

Web

• Storybook
• Redux Toolkit

Getting Started

• Clone the repository

git clone https://github.com/appliedblockchain/launchpad-ts <project_name>

• Install dependencies

cd <project_name>
yarn

• Create .env file from .env.dev.

• Run the project in docker

yarn start

• Keep dependencies updated

yarn upgrade-interactive

Project Structure

Package	Description
api	API server.
web	Web interface.

Development Tips

Check docs inside this repository.