Skip to content
holujsPublic

About

Holu codebase containing real world examples (CRUD, auth, i18n, advanced patterns, etc) that adheres to the RealWorld spec and API.

Topics

Resources

Contributing

Stars

10 stars

Watchers

3 watching

Forks

Repository files navigation

RealWorld Example App

Holu codebase containing real world examples (CRUD with @holu/typeorm, auth, i18n, OpenAPI with validation, etc) that adheres to the RealWorld spec and API.

This codebase was created to demonstrate a fully fledged backend application built with Holu including CRUD operations with TypeORM (@holu/typeorm), authentication, routing, pagination, and more.

Prerequisites

Please make sure that Node.js >= v24.0.0 is installed on your operating system.

Getting started

This monorepository includes Holu applications starter. Packages are in ESM format and have native Node.js aliases starting with #.

All packages are located in packages/* directory.

From start you need:

  1. Clone the project
git clone https://github.com/holujs/realworld.git my-app
cd my-app
  1. Bootstrap the project
npm install
  1. Copy packages/server/.env-example to packages/server/.env:
cp packages/server/.env-example packages/server/.env

And fill this file.

  1. Then create database (for example realworld), grant access permissions for this database, and execute MySQL-dump from packages/server/sql/dump/info.sql.

Start the web server

npm start

After that, see OpenAPI docs on http://0.0.0.0:3000/api/openapi.

Tests

To run tests:

npm test

About

Holu codebase containing real world examples (CRUD, auth, i18n, advanced patterns, etc) that adheres to the RealWorld spec and API.

Topics

Resources

Contributing

Stars

10 stars

Watchers

3 watching

Forks

Used by

Contributors

Languages