ace-api

0.7.50 • Public • Published

ACE API

Content API with included RESTish server.

Documentation

Documentation is currently a work in progress.

http://petstore.swagger.io/?url=https://raw.githubusercontent.com/homerjam/ace-api/master/docs/api.json#/

Installation

Push design docs to your couchdb instance using DB_URL stored in .env file:

$ npm run db:design [DOC_NAME] [DB_NAME[,DB_NAME,DB_NAME]]

Development

pnpm env use --global 14

yarn
yarn dev

yarn release

Email template preview

http://localhost:5001/email/preview?slug=twin&templateSlug=twin/newsletter&mjml=true

Environment Variables

PORT=5000

ENVIRONMENT=development|testing|production
DEBUG=false # Change to nano etc

DEV_USER_ID=
DEV_SLUG=
DEV_ROLE=
DEV_EMAIL=

CACHE_ENABLED=false
CACHE_TTL=30
CACHE_COMPRESS=false

DB_NAME=
DB_URL=

API_PREFIX=
API_BLACKLIST_TOKEN=
API_BLACKLIST_REFERRER=

SESSION_SECRET=
SESSION_TTL=

AUTH_TOKEN_SECRET=
AUTH_SUPER_USER_ID=

ASSIST_URL=
ASSIST_USERNAME=
ASSIST_PASSWORD=

CMS_TITLE=
CMS_URL=

EMBEDLY_API_KEY=

LOGENTRIES_TOKEN=

REDIS_URL=
# or
REDIS_HOST=
REDIS_PORT=
REDIS_PASSWORD=

STRIPE_CLIENT_ID=
STRIPE_CLIENT_SECRET=
STRIPE_API_KEY=

GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=

INSTAGRAM_CLIENT_ID=
INSTAGRAM_CLIENT_SECRET=

SPOTIFY_CLIENT_ID=
SPOTIFY_CLIENT_SECRET=

VIMEO_CLIENT_ID=
VIMEO_CLIENT_SECRET=

TWITTER_ACCESS_TOKEN_KEY=
TWITTER_ACCESS_TOKEN_SECRET=
TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=

Useful

# Heroku rebuild (similar to rm -rf node_modules locally)
$ heroku repo:purge_cache -a appname && \
    git commit --allow-empty -m "rebuild" && \
    git push heroku master

Dependencies (54)

Dev Dependencies (23)

Package Sidebar

Install

npm i ace-api

Weekly Downloads

135

Version

0.7.50

License

SEE LICENSE IN LICENSE

Unpacked Size

808 kB

Total Files

93

Last publish

Collaborators

  • homerjam