Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 1.03 KB

getting-started.md

File metadata and controls

42 lines (25 loc) · 1.03 KB

Starting a new project

Install Sakura CLI globally

npm install --global @sakuraapi/cli

Test to see if you have successfully installed the sakur API CLI by running

sapi help

Create a working directory

Start by creating a working directory for your project.

mkdir example-api

run sapi init

cd example init

sapi init

You will go through a series of prompts to configure the project.

  1. package.json preferences:

    1. Author:

      Your name, handle, alias, pseudonym, etc.

    2. Description: Project description

    3. License: Pick a license. If you need help visit https://choosealicense.com/

    4. Project Name (npm name): Project name

    5. Version: If you need help visit http://semver.org

  2. src/config/environment.ts preferences: 1. What JWT role does this server fulfill?:

    This has to do with the authentication needs of your project. Your choices are

    • a for audience
    • i for issuer
    • n for none
    • H for Help