Skip to content

Commit 8d1b9d4

Browse files
authored
README file is updated
1 parent 7287697 commit 8d1b9d4

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,15 @@ Simple [GraphQL](https://graphql.org/) APIs implementation using [Node JS](https
33

44
This example illustrates how to deploy [GraphQL](https://graphql.org/) APIs using [NodeJS](https://nodejs.org/en/docs/) functions running on [AWS Lambda](https://aws.amazon.com/lambda/) using the traditional [Serverless](https://www.serverless.com/framework/docs/providers/aws/guide/intro) Framework. The deployed functions work with [MongoDB Atlas](https://www.mongodb.com/docs/atlas/).
55

6-
To work with [GraphQL](https://graphql.org/) features, i.e. **Type Definitions, Mutations, Queries, Resolvers** [Apollo Server](https://www.apollographql.com/docs/apollo-server/) is used.
6+
To work with [GraphQL](https://graphql.org/) features, i.e. **Type Definitions, Mutations, Queries, Resolvers** the framework [Apollo Server](https://www.apollographql.com/docs/apollo-server/) is used.
77

8-
This Example works with [AWS HTTP API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html) events.
9-
10-
<!---
11-
For faster response with the APIs [Redis](https://redis.io/) *caching* is used.
12-
-->
8+
This Example works with [AWS HTTP API](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html) events i.e. `httpApi`. All *logs* for the function is kept in [AWS Cloudwatch](https://aws.amazon.com/cloudwatch/) i.e *persistent*.
9+
1310
For *session tracking* [JSON Web Token (JWT)](https://jwt.io/) is used.
14-
All *logs* for the function is kept in [AWS Cloudwatch](https://aws.amazon.com/cloudwatch/) i.e *persistent*.
1511

1612
To use the code in this example you **must** have an valid [AWS account](https://aws.amazon.com/account/) and necessary [AWS IAM](https://aws.amazon.com/iam/) roles and programmatic access to an user. You **must** have a [MongoDB Atlas](https://www.mongodb.com/docs/atlas/) account.
1713

14+
**This application is closely related to [simple-book-search-react](https://github.com/anijitsahu/simple-book-search-react). For Frontend deployment please check the repo [simple-book-search-react](https://github.com/anijitsahu/simple-book-search-react)**
1815

1916

2017
## Features
@@ -60,7 +57,10 @@ $ git clone git@github.com:anijitsahu/simple-apollo-server-graphql-lambda.git
6057
Install all the necessary dependencies by going inside the directory
6158

6259
```bash
60+
# Navigating inside the directory
6361
$ cd simple-apollo-server-graphql-lambda
62+
63+
# To install all the necessary dependencies
6464
$ npm install
6565
```
6666

@@ -192,11 +192,17 @@ mutation UpdateAuthorMutation(
192192

193193
**POST** /url-of-the-deployed-lambda/graphql
194194

195+
Following username and password is valid
196+
197+
|Username | Password |
198+
|---|---|
199+
|admin | admin123 |
200+
195201
```javascript
196202
query CreateTokenQuery{
197203
// these are the only possible username and password
198204
createToken(username: "admin", password: "admin123") {
199205
token
200206
}
201207
}
202-
```
208+
```

0 commit comments

Comments
 (0)