1 | # ACE API
|
2 |
|
3 | Content API with included RESTish server.
|
4 |
|
5 | ### Documentation
|
6 |
|
7 | Documentation is currently a work in progress.
|
8 |
|
9 | http://petstore.swagger.io/?url=https://rawgit.com/StudioThomas/ace-api/master/docs/api.json#/
|
10 |
|
11 | ### Installation
|
12 |
|
13 | Push design docs to your couchdb instance using `DB_URL` stored in `.env` file:
|
14 |
|
15 | ```
|
16 | $ npm run design [DOC_NAME] [DB_NAME[,DB_NAME,DB_NAME]]
|
17 | ```
|
18 |
|
19 | ### Environment Variables
|
20 |
|
21 | PORT=5000
|
22 |
|
23 | ENVIRONMENT=development|testing|production
|
24 | DEBUG=false # Change to nano etc
|
25 |
|
26 | DEV_USER_ID=
|
27 | DEV_SLUG=
|
28 | DEV_ROLE=
|
29 | DEV_EMAIL=
|
30 |
|
31 | CACHE_ENABLED=false
|
32 | CACHE_TTL=30
|
33 | CACHE_COMPRESS=false
|
34 |
|
35 | DB_NAME=
|
36 | DB_URL=
|
37 |
|
38 | API_PREFIX=
|
39 | API_BLACKLIST_TOKEN=
|
40 | API_BLACKLIST_REFERRER=
|
41 |
|
42 | SESSION_SECRET=
|
43 | SESSION_TTL=
|
44 |
|
45 | AUTH_TOKEN_SECRET=
|
46 |
|
47 | ASSIST_URL=
|
48 | ASSIST_USERNAME=
|
49 | ASSIST_PASSWORD=
|
50 |
|
51 | CMS_TITLE=
|
52 | CMS_URL=
|
53 |
|
54 | EMBEDLY_API_KEY=
|
55 |
|
56 | LOGENTRIES_TOKEN=
|
57 |
|
58 | REDIS_URL=
|
59 | # or
|
60 | REDIS_HOST=
|
61 | REDIS_PORT=
|
62 | REDIS_PASSWORD=
|
63 |
|
64 | STRIPE_CLIENT_ID=
|
65 | STRIPE_CLIENT_SECRET=
|
66 | STRIPE_API_KEY=
|
67 |
|
68 | GOOGLE_CLIENT_ID=
|
69 | GOOGLE_CLIENT_SECRET=
|
70 |
|
71 | INSTAGRAM_CLIENT_ID=
|
72 | INSTAGRAM_CLIENT_SECRET=
|
73 |
|
74 | SPOTIFY_CLIENT_ID=
|
75 | SPOTIFY_CLIENT_SECRET=
|
76 |
|
77 | VIMEO_CLIENT_ID=
|
78 | VIMEO_CLIENT_SECRET=
|
79 |
|
80 | TWITTER_ACCESS_TOKEN_KEY=
|
81 | TWITTER_ACCESS_TOKEN_SECRET=
|
82 | TWITTER_CONSUMER_KEY=
|
83 | TWITTER_CONSUMER_SECRET=
|
84 |
|
85 | ### Useful
|
86 |
|
87 | # Heroku rebuild (similar to rm -rf node_modules locally)
|
88 | $ heroku repo:purge_cache -a appname && \
|
89 | git commit --allow-empty -m "rebuild" && \
|
90 | git push heroku master
|