Description

Nest framework TypeScript starter repository.

This service is structured to be a server rendered multi-page app of a more traditional structure. Uses HTMX with a custom JSX renderer as the templating engine.

What runs the API beneath Nest?

By default Nest uses express, this uses the optional fastify back end which is faster.

What templating system does this use?

Think of this as a much more traditional multi page app setup.

The JSX renderer which renders serverside to HTML can be found and modified at src/lib/jtmx, the types file in there can be updated to define any new JSX attributes you'd like to use.

Components using JSX will be rendered to HTML. Do not confuse the presence of JSX with React. There are no hooks, treat the JSX components as a traditional server rendered multi-page app that uses HTMX.

How is authentication currently done?

Authentication is done via a session system with a database table to store the sessions.

What database layer is used?

Database management is done via Drizzle configured for Postgres.

A Docker compose file exists to assist with creating a local database.

Headless

If you wish to use this as a headless API for a more traditional single page app front end like React, just delete the features and components that are built for MPA.

Installation

$ npm install

Running the app

Create a copy of .env.sample as .env with appropriate variables set.

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Creating migratinos

To create migrations, update the entity schemas or create new ones in the database module src/modules/database/database.structure.ts.

Once done run the db:sync command to generate a migration.

$ npm run db:sync

New migrations will be run in the database when the Nest server boots.

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Building

# entire app
$ npm run build

# just styles
$ npm run sass

License

Nest is MIT licensed.