Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rburgst/sports-keystone-next
A keystone/next/typescript repo demonstrating how to use graphql with keystone
https://github.com/rburgst/sports-keystone-next
Last synced: 2 days ago
JSON representation
A keystone/next/typescript repo demonstrating how to use graphql with keystone
- Host: GitHub
- URL: https://github.com/rburgst/sports-keystone-next
- Owner: rburgst
- Created: 2021-10-26T08:19:49.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-03-01T07:01:31.000Z (almost 3 years ago)
- Last Synced: 2024-11-08T17:53:07.224Z (about 2 months ago)
- Language: TypeScript
- Size: 1.98 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Keystone Project Starter
Welcome to Keystone!
Run
```
yarn dev
```
To view the config for your new app, look at [./keystone.ts](./keystone.ts)
This project starter is designed to give you a sense of the power Keystone can offer you, and show off some of its main features. It's also a pretty simple setup if you want to build out from it.
We recommend you use this alongside our [getting started walkthrough](https://keystonejs.com/docs/walkthroughs/getting-started-with-create-keystone-app) which will walk you through what you get as part of this starter.
If you want an overview of all the features Keystone offers, check out our [features](https://keystonejs.com/why-keystone#features) page.
## Some Quick Notes On Getting Started
### Changing the database
We've set you up with an [SQLite database](https://keystonejs.com/docs/apis/config#sqlite) for ease-of-use. If you're wanting to use PostgreSQL, you can!
Just change the `db` property on line 16 of the Keystone file [./keystone.ts](./keystone.ts) to
```typescript
db: {
provider: 'postgresql',
url: process.env.DATABASE_URL || 'DATABASE_URL_TO_REPLACE',
}
```
And provide your database url from PostgreSQL.
For more on database configuration, check out or [DB API Docs](https://keystonejs.com/docs/apis/config#db)
### Auth
We've put auth into its own file to make this humble starter easier to navigate. To explore it without auth turned on, comment out the `isAccessAllowed` on line 21 of the Keystone file [./keystone.ts](./keystone.ts).
For more on auth, check out our [Authentication API Docs](https://keystonejs.com/docs/apis/auth#authentication-api)
### Adding a frontend
As a Headless CMS, Keystone can be used with any frontend that uses GraphQL. It provides a GraphQL endpoint you can write queries against at `/api/graphql` (by default [http://localhost:3000/api/graphql](http://localhost:3000/api/graphql)). At Thinkmill, we tend to use [Next.js](https://nextjs.org/) and [Apollo GraphQL](https://www.apollographql.com/docs/react/get-started/) as our frontend and way to write queries, but if you have your own favourite, feel free to use it.
A walkthrough on how to do this is forthcoming, but in the meantime our [todo example](https://github.com/keystonejs/keystone-react-todo-demo) shows a Keystone set up with a frontend. For a more full example, you can also look at an example app we built for [Prisma Day 2021](https://github.com/keystonejs/prisma-day-2021-workshop)
### Embedding Keystone in a Next.js frontend
While Keystone works as a standalone app, you can embed your Keystone app into a [Next.js](https://nextjs.org/) app. This is quite a different setup to the starter, and we recommend checking out our walkthrough for that [here](https://keystonejs.com/docs/walkthroughs/embedded-mode-with-sqlite-nextjs#how-to-embed-keystone-sq-lite-in-a-next-js-app).