Getting Started

Before learning about how to write a hypermedia API, let’s start by running the existing one. To do this best, you should start up the API and the client api.

The live demo:

• api.todo.semanticlink.io
• credentials (test-1@semanticlink.io with password 1234qwerZXCV)

Run demo server and client

Install dependencies

git clone git://github.com/semanticlink/todo-rest-api

All dependencies are documented in this Readme and include:

• Docker
• Rider (api)
• WebStorm (client)
• .NET Core 2.1 SDK v.2.1.401
• nodejs (>= 10.0.0)
• yarn (1.6.0 or above)

Start applications

1. Start the database.

docker run -p 8000:8000 -it --rm instructure/dynamo-local-admin`

You can view this in a browser on http://localhost:8000

2. Build and run the project with the following environment variables.

    ASPNETCORE_ENVIRONMENT: Development
    ASPNETCORE_URLS: http://localhost:5000

cd api
dotnet restore

Exec Path: Api/bin/Debug/netcoreapp2.1/Api.dll
Working Directory: ./api/Api
Environment Variables: ASPNETCORE_ENVIRONMENT=Development;ASPNETCORE_URLS=http://localhost:5000

3. Build and run the client commandline with yarn (or through the IDE, eg WebStorm).

cd client
yarn install
yarn dev

It will open a browser in http://localhost:8080

4. Browse the API

open http://localhost:5000

At some stage, you will need to authenticate. The credentials are at the top of the page.