Skip to content
D
Documentation

System requirements

reference
1 min readUpdated

What you need to run Conduit

Bun is the tool required to set up and start Conduit.

This page covers two project jobs:

If you need to…Go to
Prepare the project and start the local applicationSet up and start the project
Generate build artifactsBuild the project
Sign in, register, and reach the main feedYour first day
Understand loading and unavailable statesLoading and unavailable states
Find project and demo references or authentication errorsGetting help

Build artifacts are covered in Build the project.

Before you start

Have Bun available and work from the project directory before initializing the project. Work in the project directory named by the setup instructions.

Set up and start the project

Initialize the project and start the local application with this procedure.

Prerequisites

  • Bun is available.
  • You are in the project directory.

Steps

  1. Enter bun run setup in a terminal.

  2. Enter the command for your situation:

    SituationCommand
    After the initial setupbun run start
    After a git pull updates the realworld submodulebun run setup again

Result: The local application is started from the project directory.

While the root page loads, it can show these messages:

WhenMessage
Tags are loadingLoading tags...
Tags have loaded and the tag list is emptyNo tags are here... yet.
Articles are loadingLoading articles...
The following feed has no articlesYour feed is empty. Follow some users to see their articles here, or check out the Global Feed!
The loaded article list has no articlesNo articles are here... yet.

Build the project

Create the project's build artifacts with this procedure.

Prerequisites

  • Bun is available.
  • You are in the project directory.

Steps

  1. Enter bun run build in a terminal.

Result: The build artifacts are stored in dist/.

Was this page helpful?

Download as PDF
System requirements — Conduit (Angular)