https://github.com/ditsmod/realworld

Ditsmod codebase containing real world examples (CRUD, auth, i18n, advanced patterns, etc) that adheres to the RealWorld spec and API.
https://github.com/ditsmod/realworld

ditsmod i18n nodejs-framework realworld realworld-backend

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ditsmod/realworld
• Owner: ditsmod
• License: mit
• Created: 2021-12-19T10:06:18.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T11:38:54.000Z (2 months ago)
• Last Synced: 2024-10-29T13:26:31.488Z (2 months ago)
• Topics: ditsmod, i18n, nodejs-framework, realworld, realworld-backend
• Language: TypeScript
• Homepage:
• Size: 3.43 MB
• Stars: 9
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ![RealWorld Example App](logo.png)

> ### Ditsmod codebase containing real world examples (CRUD, auth, i18n, OpenAPI with validation, etc) that adheres to the [RealWorld](https://github.com/gothinkster/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](https://ditsmod.github.io/en/) applications seed. Packages are in ESM format and have [native Node.js aliases](https://nodejs.org/api/packages.html#subpath-imports) starting with `#`.

All packages are located in `packages/*` directory.

From start you need:

1. Clone the project

```bash

git clone https://github.com/ditsmod/realworld.git my-app

cd my-app

```

2. Bootstrap the project

```bash

npm install

```

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

```bash

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](./packages/server/sql/dump/info.sql).

## Start the web server

```bash

npm start

```

After that, see OpenAPI docs on [http://0.0.0.0:3000/api/openapi](http://0.0.0.0:3000/api/openapi).

## Postman tests

To run [postman tests](https://github.com/gothinkster/realworld/blob/main/api/Conduit.postman_collection.json):

```bash

npm test

```