Ecency vision – API
- node ^12.0.0
- yarn
$ git clone https://github.com/ecency/vision-api
$ cd vision-api
$ yarn
$ nano src/config.ts
PRIVATE_API_ADDR
- private api endpointPRIVATE_API_AUTH
- private api authHIVESIGNER_CLIENT_SECRET
- hivesigner client secretSEARCH_API_ADDR
- hivesearcher api endpointSEARCH_API_SECRET
- hivesearcher api auth tokenREVUE_TOKEN
- revue api auth token
$ yarn start
- Make sure to branch off your changes from
main
branch. - Make sure to run
yarn test
and add tests to your changes. - Code on!
You can use official ecency/api:latest
image to run Vision locally, deploy it to staging or even production environment. The simplest way is to run it with following command:
docker run -it --rm -p 3000:3000 ecency/vision:latest
Configure the instance using following environment variables:
PRIVATE_API_ADDR
PRIVATE_API_AUTH
HIVESIGNER_CLIENT_SECRET
SEARCH_API_ADDR
SEARCH_API_SECRET
REVUE_TOKEN
docker run -it --rm -p 3000:3000 -e PRIVATE_API_ADDR=https://api.example.com -e PRIVATE_API_AUTH=verysecretpassword ecency/api:latest
You can easily deploy a set of vision instances to your production environment, using example docker-compose.yml
file. Docker Swarm will automatically keep it alive and load balance incoming traffic between the containers:
docker stack deploy -c docker-compose.yml vision-api
To report a non-critical issue, please file an issue on this GitHub project.
If you find a security issue please report details to: security@ecency.com
We will evaluate the risk and make a patch available before filing the issue.