Skip to content
D
Documentation

Getting help

reference
5 min readUpdated

What Conduit help covers

Conduit is a social blogging site for publishing and discussing articles. Authentication is the sign-in or account-creation part of the application. Use this page when you need project documentation, the live demo, or help with authentication and connection messages.

If you need to…Go to
Understand what Conduit isWhat is Conduit
Find project documentation or the live demoFind project and demo help
Prepare the project before starting itSystem requirements
Sign in or create an accountRecognize the authentication screen
Understand loading or unavailable statesAuthentication and loading messages
Resolve a general errorGeneral error messages
Work through a broader setup or route problemCommon issues and solutions

The project documentation explains how the application works. The live demo is the place to use the application itself. If you need setup, continue with the checklist below.

Before you look for help

Before starting the project, have the required setup and the route that matches your task in front of you.

Before you startHave ready
Install the project prerequisiteBun
Get the projectgit clone https://github.com/realworld-apps/angular-realworld-example-app.git
Install dependencies and initialise the projectbun run setup
Start the projectbun run start
Reinitialise after a submodule updateRun bun run setup again after a git pull that updates the realworld submodule
Choose the authentication task/login for sign-in or /register for account creation

The application uses the /login and /register routes for these two tasks. For setup questions, continue with the project and demo resources below.

Find project and demo help

Project documentation is the reference for how the project works; the live demo is the place to use Conduit. Use the links below according to the question you need to answer.

If you need to…Open
Read the project documentationProject documentation
Use the applicationLive demo
Get the project sourceAngular Example App
Read the broader Angular guidanceRealWorld Angular
Read the Angular frontend or Realworld references shown on HomeAngular frontend or Realworld
  1. Choose the row that matches your question and open the linked resource.

Result: You are at the project, demo, or guidance resource that matches your question. If you are using the application, continue with the authentication-screen guidance.

Recognize the authentication screen

The authentication screen lets you enter the application as a user or create an account. The same screen serves both tasks, and its title and fields change with the route.

Prerequisites

  • You know whether you are signing in at /login or creating an account at /register.
  • You have the email address and password for sign-in, or the username, email address, and password for account creation.

Steps

  1. In the unauthenticated header, select the link for your task.

    TaskSelect
    Sign in to an existing accountSign in
    Create an accountSign up
  2. Complete the fields for your task.

    TaskFields to complete
    Sign in to an existing accountEmail and Password
    Create an accountUsername, Email, and Password
  3. Select Sign in for an existing account or Sign up for a new account.

The sign-in form provides Need an account? to reach registration. The registration form provides Have an account? to return to sign-in.

Result: The selected authentication form is complete and its submit control matches the route: Sign in on /login or Sign up on /register.

Handle authentication and connection problems

An authentication state tells you whether the application is loading, authenticated, unauthenticated, or temporarily unavailable. The header communicates this state while the application checks the session or waits for the server. Error messages appear in a list above the authentication form when a request returns errors. Each server error is rendered as <key> <message>.

What you seeWhat it meansWhat to do
Loading...The application is checking the current session.Wait for the authentication state to finish loading.
Connecting...Authentication is temporarily unavailable and the application is retrying.Leave the page open while the application performs its automatic retry.
Unable to connect. Please check your internet connection.A request did not provide a usable error body or the network could not connect.Check the connection and retry the task.
A list item in the form of <key> <message>The server returned a named error and its message.Read the message next to its key and correct the indicated input.
  1. Find the visible message in the table and follow its corresponding action.

Result: The authentication state is loading, authenticated, or temporarily unavailable, and any visible error message identifies the response that needs attention.

The header shows different links for each state:

Authentication stateHeader content
UnauthenticatedHome, Sign in, and Sign up
AuthenticatedHome, New Article, Settings, and the current user's name
Temporarily unavailableHome, New Article, Settings, and Connecting...
LoadingHome and Loading...

When authentication is temporarily unavailable, the application retries after 2, 4, and 8 seconds, then every 16 seconds. A non-/user request that returns 401 purges the authentication state.

For the complete shared message reference, open General error messages.

Choose the next help path

After you identify the task or message, choose the matching help topic below.

Your next questionContinue with
How do I sign in?Sign in
How do I create an account?Create an account
What do the authentication states mean?Authentication and loading messages
What happens while the application is loading or unavailable?Loading and unavailable states
What does a general error message mean?General error messages
What should I try for a wider setup or route problem?Common issues and solutions

Was this page helpful?

Download as PDF
Getting help — Conduit (Angular)