Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oslabs-beta/Olympus
A hybrid caching library for GraphQL written for Javascript Express
https://github.com/oslabs-beta/Olympus
caching graphql graphql-server localstorage redis typescript
Last synced: 12 days ago
JSON representation
A hybrid caching library for GraphQL written for Javascript Express
- Host: GitHub
- URL: https://github.com/oslabs-beta/Olympus
- Owner: oslabs-beta
- License: mit
- Created: 2022-05-06T22:42:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-10T23:53:20.000Z (over 1 year ago)
- Last Synced: 2024-08-17T01:19:11.443Z (3 months ago)
- Topics: caching, graphql, graphql-server, localstorage, redis, typescript
- Language: JavaScript
- Homepage:
- Size: 75.8 MB
- Stars: 53
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome to Olympus Caching!
# []() [](./LICENSE) [](https://www.npmjs.com/package/olympus-cache) [](https://medium.com/@marshallkkim29/olympus-an-intuitive-hybrid-caching-solution-for-graphql-b18a08c5045d) [](https://www.linkedin.com/company/olympus-caching/)
Olympus is a hybrid caching library for GraphQL written for Javascript Express
## Features
- Automatically creates and caches GraphQL queries.
- Integrates with any server running on Express/Node.js.
- Includes caching with Redis and in the browser's local storage.
Check out [our demo site](http://olympuscache.com) to see what Olympus can do.
---
## Table of Contents
- [Install](#install)
- [Server Setup](#server)
- [Making Queries (Client-side)](#queries)
- [Making Mutations (Client-side)](#mutations)
- [The Team ](#team )
- [License](#license )
---
## Install Olympus
Install our Express library via npm
```bash
npm install olympus-cache
```
## Set up your Express server
1. Import our Redis Middleware
```javascript
const RedisCache = require('olympus-server');
```
2. Set up your Redis Server
```javascript
const redis = require('redis');
const redisClient = redis.createClient({
host: "localhost",
port: 6379,
});
redisClient.connect();
const redisInstance = new RedisCache(redisClient, '//insert url with /graphql endpoint here');
// REQUIRED
app.use(express.json())
app.use(express.urlencoded({ extended: true }));
```
3. Add the following endpoints
```javascript
app.use('/olympus', redisInstance.cacheResponse, (req, res) => {
res.status(200).send(res.locals)
});
app.use('/graphql', graphqlHTTP({schema, graphiql: true}));
```
4. Don't forget to run the command line 'redis-server' on the machine with your server
## Making Queries
1. Import `Olympus` in files that make GraphQL queries
```javascript
import { Olympus } from 'olympus-fetch';
```
2. Olympus is designed to make it easy to switch over from the Fetch API. All you have to do is replace the word `fetch` with the word `Olympus`. Remove the endpoint argument, and adjust the 'body' key inside the second arugment.
For example, here's how you might send a GraphQL request using the Fetch API:
```javascript
fetch('/graphql', {
method: 'POST',
headers: { 'Content-Type': 'application/graphql' },
body: // query string
})
.then(/* code */)
```
And here's what that same request looks like using Olympus:
```javascript
Olympus({
method: 'POST',
headers: { 'Content-Type': 'application/graphql' },
body: JSON.stringify({query: // query string})
})
.then(/* code */)
```
Simply replace `fetch` with `Olympus` wherever the client-side code queries the GraphQL API, and you're done! You've set up caching inside your client's browser Local Storage.
## Making Mutations
In order to make a mutation, follow the same steps above. Simply replace `fetch` with `Olympus` wherever the client-side code makes mutations using the GraphQL API, and you're done! Simply enter your string containing the mutation inside of the key "query".
```javascript
Olympus({
method: 'POST',
headers: { 'Content-Type': 'application/graphql' },
body: JSON.stringify({query: // mutation string})
})
.then(/* code */)
```
## The Team
Adam Lang | [GitHub](https://github.com/AdamLang96) | [LinkedIn](https://www.linkedin.com/in/adam-lang-573a2b149/)
Bryan Kim | [GitHub](https://github.com/Bkimmm) | [LinkedIn](https://www.linkedin.com/in/bkimmm/)
Kevin Le | [GitHub](https://github.com/kle160) | [LinkedIn](https://www.linkedin.com/in/kevin-le-3ab05971/)
Marshall Kim | [GitHub](https://github.com/marshallkkim) | [LinkedIn](https://www.linkedin.com/in/marshallkkim/)
## License
This product is licensed under the MIT License - see the LICENSE file for details.
This is an open source product.
This product is accelerated by [OS Labs](https://opensourcelabs.io/).