https://github.com/openocean-finance/OpenOcean-API

openocean sdk
https://github.com/openocean-finance/OpenOcean-API

Last synced: 2 months ago
JSON representation

openocean sdk

• Host: GitHub
• URL: https://github.com/openocean-finance/OpenOcean-API
• Owner: openocean-finance
• Created: 2021-10-20T08:31:56.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-02-19T03:28:11.000Z (over 1 year ago)
• Last Synced: 2024-08-01T08:15:34.545Z (10 months ago)
• Language: TypeScript
• Size: 479 KB
• Stars: 16
• Watchers: 2
• Forks: 16
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome - openocean-finance/OpenOcean-API - openocean sdk (TypeScript)

README

        
## Notice

We strongly recommend that users deploy it themselves, rather than simply call it!

# openocean-api

openocean-api using typescript && egg

## QuickStart

### Development

```bash

$ npm i

$ npm run dev

$ open http://localhost:7003/

```

Don't tsc compile at development mode, if you had run `tsc` then you need to `npm run clean` before `npm run dev`.

### Deploy

```bash

$ npm run tsc

$ npm start

```

### Npm Scripts

- Use `npm run lint` to check code style

- Use `npm test` to run unit test

- se `npm run clean` to clean compiled js at development mode once

### Requirement

- Node.js 8.x

- Typescript 2.8+