Fission FileCoin Cosigner
Get started developing...
# install deps
npm ci
# run in development mode
yarn run dev
# run tests
yarn run test
There are two key files:
server/routes.ts
- This references the implementation of all of your routes. Add as many routes as you like and point each route your express handler functions.server/common/api.yaml
- This file contains your OpenAPI spec. Describe your API here. It's recommended that you to declare any and all validation logic in this YAML.express-no-stress-typescript
uses express-openapi-validator to automatically handle all API validation based on what you've defined in the spec.
Install all package dependencies (one time operation) with lockfile.
npm ci
# or
yarn install --frozen-lockfile
Runs the application is development mode. Should not be used in production.
The server can take environment variables from .env
file. To get started easily, you can copy .env.example
to .env
to set some default variables for getting started.
# optionally
cp .env.example .env
yarn run dev
or debug it
yarn run dev:debug
Compiles the application and starts it in production production mode.
npm run compile
npm start
Run the Mocha unit tests
npm test
or debug them
npm run test:debug
- Open your browser to http://localhost:3000
- Invoke the
/examples
endpointcurl http://localhost:3000/api/v1/examples
npm run dev:debug
npm run test:debug
Add these contents to your .vscode/launch.json
file