A fake banking API that's designed to be used in place of the Galileo API for testing purposes.
Built with the koa Node.js framework. Based on the node-typescript-koa-rest boilerplate.
Can be deployed to AWS Lambda (plus DynamoDB and API Gateway) with copernicus-lambda-deployer.
Can be installed from npm with
npm install copernicus-api
.
Requires either a real AWS DynamoDB back-end, or dynamodb-local.
To work locally with this project, follow the steps below:
- Fork, clone or download this project
npm install
- Copy
.example.env
to.env
and set variables as required - setJWT_SECRET
to a secret value, you can then go to https://jwt.io/ to generate a JWT based on that secret, you'll need to send that JWT in requests to the Copernicus API npm run create-tables
- Preview your project:
npm run watch-server
- Go to
http://localhost:3000/swagger-html/
to CRUD away at the API
To build and run the project in JS: npm run build && npm run start
To run unit tests: npm run test
- Bump the version number in
package.json
npm run build
npm publish
Built by Douugh.