create-superface-app

Set up a Superface project by running one command. You can set up a project using --example flag with Github URL where example of Superface project is located, or by using one of the official Superface examples.

Table of Contents

• Background
• Prerequisites
• Quick start
• Install
• Usage
• Security
• Support
• Development
• Maintainers
• Contributing
• License

Background

Superface (super-interface) is a higher-order API, an abstraction on top of the modern APIs like GraphQL and REST. Superface is one interface to discover, connect, and query any capabilities available via conventional APIs.

Through its focus on application-level semantics, Superface decouples the clients from servers, enabling fully autonomous evolution. As such it minimizes the code base as well as errors and downtimes while providing unmatched resiliency and redundancy.

Superface allows for switching capability providers without development at a runtime in milliseconds. Furthermore, Superface decentralizes the composition and aggregation, and thus creates an Autonomous Integration Mesh.

Motivation behind Superface is nicely described in this video from APIdays conference.

You can get more information at https://superface.ai and https://developer.superface.dev.

Quick start

npx create-superface-app my-app --example starwars

Install

To install the create-superface-app globally you can use one of the following commands:

# if using yarn
yarn global add create-superface-app

# if using npm
npm install --global create-superface-app

Usage

create-superface-app DIRECTORY

Set up a Superface project by running one command

USAGE
  $ create-superface-app DIRECTORY

ARGUMENTS
  DIRECTORY  File path to project directory where to set up a Superface project

OPTIONS
  -e, --example=example  URL to repository of some Superface project or name of official Superface example.
  -h, --help             show CLI help
  -q, --quiet            When set to true, disables the logging.
  -v, --version          show CLI version
  --useNpm               When set to true, installs local packages with npm rather than yarn

EXAMPLE
  $ create-superface-app <project-directory> --example https://github.com/superfaceai/superface-example-starwars
  $ create-superface-app <project-directory> --example starwars
  $ create-superface-app <project-directory> --example starwars --useNpm

See code: src/create-superface-app.ts

Usage example:

create-superface-app my-app --example starwars

cd my-app

yarn start "Luke Skywalker"

Security

Superface is not man-in-the-middle so it does not require any access to secrets that are needed to communicate with provider API. Superface CLI only prepares super.json file with authorization fields in form of environment variable. You just set correct variables and communicate directly with provider API.

You can find more information in SDK repository.

Github PAT

To access private examples that are located in private Github repositories, you can provide Github Personal Access Token in two different ways:

• paste in cli when prompted for token (this happens when repository can't be found on first try)
• create an enviroment variable GITHUB_PAT in working directory from where you will be using create-superface-app.

Support

If you need any additional support, have any questions or you just want to talk you can do that through our documentation page.

Development

When developing, start with cloning the repository using git clone https://github.com/superfaceai/create-superface-app.git (or git clone [email protected]:superfaceai/create-superface-app.git if you have repository access).

After cloning, the dependencies must be downloaded using yarn install or npm install.

Now the repository is ready for code changes.

The package.json also contains scripts (runnable by calling yarn <script-name> or npm run <script-name>):

• test - run all tests
• lint - lint the code (use lint --fix to run autofix)
• format - check the code formatting (use firmat:fix to autoformat)
• prepush - run test, lint and format checks. This should run without errors before you push anything to git.

Lastly, to build a local artifact run yarn build or npm run build.

To install a local artifact globally, symlink the binary (ln -s bin/create-superface-app <target>) into one of the following folders:

• ~/.local/bin - local binaries for your user only (may not be in PATH yet)
• /usr/local/bin - system-wide binaries installed by the system administrator
• output of yarn global bin - usually the same as /usr/local/bin

Note: The project needs to be built (into the dist folder) to run create-superface-app command.

Maintainers

• @Martin Albert

Contributing

Please open an issue first if you want to make larger changes

Feel free to contribute! Please follow the Contribution Guide.

Licenses of node_modules are checked during CI/CD for every commit. Only the following licenses are allowed:

• 0BDS
• MIT
• Apache-2.0
• ISC
• BSD-3-Clause
• BSD-2-Clause
• CC-BY-4.0
• CC-BY-3.0;BSD
• CC0-1.0
• Unlicense

Note: If editing the README, please conform to the standard-readme specification.

License

The Superface is licensed under the MIT. © 2021 Superface