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

This codebase was created to demonstrate a fully fledged fullstack application built with Ditsmod including CRUD operations, authentication, routing, pagination, and more.

Prerequisites

Please make sure that Node.js >= v20.6.0 is installed on your operating system.

Getting started

This monorepository includes Ditsmod applications seed. 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/ditsmod/realworld.git my-app
cd my-app

2. Bootstrap the project

npm install

3. Copy packages/server/.env-example to packages/server/.env:

cp packages/server/.env-example packages/server/.env

And fill this file.

4. Then create database (for example real_world), 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 and paste "http://0.0.0.0:3000/api/openapi.json" (or *.yaml) in the field above.

Postman tests

To run postman tests:

npm test