Skip to content

ajktown/api

Repository files navigation

AJK Town API

"Buy Me A Coffee"

Table of Contents

Overview

AJK Town API is the second generation project produced by AJK Town, or AJ Kim. It was renamed after "Wordy", which once contained both API server and the Frontend source code packaged together. They are now separated into two repositories AJK Town API and AJK Town Wordnote.

https://api.ajktown.com

For Developers

Public Image

https://hub.docker.com/r/ajktown/api/tags

Push image command locally

By default, the GitHub Action will build and push the image to the Docker Hub. If you want to push the image locally, you can use the following commands:

docker build -t ajktown/api:latest .
docker push ajktown/api:latest

For Envoy

Please check the documentation here

About the starter of this project

This project is built on the starter code that Nest JS provides.

project_name="ajktown-api" # you can insert your project name
git clone https://github.com/nestjs/typescript-starter.git "${project_name}"

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Donate us Support us Follow us on Twitter

Description

Nest framework TypeScript starter repository.

Installation

$ yarn

Running the app

# development
$ yarn start

# watch mode
$ yarn start:dev

# production mode
$ yarn start:prod

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

License

Nest is MIT licensed.

About

API server source code for AJK Town Services

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages