jmcdo29 / hanas-server

Backend for Hanas, a (wip) webapp and community for conlanging.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Hanas

Snyk Vulnerabilities for GitHub Repo GitHub Workflow Status better than cws

Hanas is a webapp and community built for conlanging. It is primarily inspired by the work of ConWorkShop. The backend here is built using NestJS.

Installation

At the moment, Hanas uses SQLite3, so by default, no external database services need to be run, although this will likely change in the future.

$ npm install

Configuration

You may wish to edit the ormconfig.json to fit your particular database needs. Note that switching databases entirely will probably require you to install the relevant packages - see typeorm for more information on which databases are supported and which packages should be used.

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

# run e2e tests
$ npm run test

Note that running tests will wipe the current database!

API Description

wip

About

Backend for Hanas, a (wip) webapp and community for conlanging.

License:MIT License


Languages

Language:TypeScript 99.4%Language:JavaScript 0.6%