Skip to content
This repository was archived by the owner on Jan 9, 2023. It is now read-only.

Commit dadd79c

Browse files
committed
Update README.md
1 parent b91f652 commit dadd79c

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1-
# tf-public-api
2-
Public API for TravelFeed
1+
# Public GraphQL API for TravelFeed
2+
3+
Get your API key [in your TravelFeed Dashboard](https://travelfeed.io/dashboard) and use the API on https://api.travelfeed.io/graphql/. Send then API key as Authorization header.
4+
5+
You can find a GraphQL playground at https://api.travelfeed.io/graphql and explore the schema.
6+
7+
This readonly API is limited to retrieving your own posts.
8+
9+
# Deploy it yourself
10+
11+
This API is using serverless for deployment on AWS lambda. If you would like to run it yourself, configure a `.env` file with a MONGO_URL variable to your database and run `npm run dev` to start the development server. Deploy to AWS with `npm run deploy`.
12+
13+
You can set different environment variables by using `.env.development` and `.env.production` files. Remember to set `NODE_ENV=production` in the production environment configruation if you would like to have playground working in your deployment.

0 commit comments

Comments
 (0)