https://github.com/patrick-emmanuel/spiked-cbt
https://github.com/patrick-emmanuel/spiked-cbt
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/patrick-emmanuel/spiked-cbt
- Owner: patrick-emmanuel
- Created: 2019-03-08T16:44:42.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-26T11:09:54.000Z (about 7 years ago)
- Last Synced: 2025-02-23T17:30:18.491Z (over 1 year ago)
- Language: JavaScript
- Size: 325 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🚀 Bootstrap your fullstack GraphQL app within seconds
Advanced starter kit for a fullstack GraphQL app with React and Node.js - based on best practices from the GraphQL community.
## Features
- **Scalable GraphQL server:** The server uses [`apollo-server-express`](https://www.apollographql.com/docs/apollo-server/servers/express.html) which is based on Apollo Server & Express
- **Pre-configured Apollo Client:** The project comes with a preconfigured setup for Apollo Client
- **GraphQL database:** Includes GraphQL database binding to [Prisma](https://www.prismagraphql.com) (running on PostgreSQL)
- **Tooling**: Out-of-the-box support for [GraphQL Playground](https://github.com/prisma/graphql-playground) & [query performance tracing](https://github.com/apollographql/apollo-tracing)
- **Extensible**: Simple and flexible [data model](./database/datamodel.graphql) – easy to adjust and extend
- **No configuration overhead**: Preconfigured [`graphql-config`](https://github.com/prisma/graphql-config) setup
- **Storybook JS**: Build and test your components with storybookjs. Learn more [`here`](https://www.storybookjs.org)
- **Typescript**: Write and ship code with confidence with static typing
- **Docker**: Develop your application in containerized format. Write once, run anywhere.
- **Caddy server**: Caddy server is setup for proxy and load-balancing
A full-fledged **React, Node and Apollo boilerplate**
## Requirements
```sh
Ensure you have node installed on your machine.
```
## Getting started
```sh
# 1. Clone the repo
git clone https://github.com/the-bionic/node-react-graphql-starter.git my-app && cd my-app
npm install --prefix client && npm install --prefix server
# 2. Start docker
docker-compose up
# 3. Deploy the prisma service.
npm run --prefix server deploy:dev OR cd server && npm run deploy:dev
# 4. View app
App is running on localhost:2015
```
## Testing
```sh
## Server:
To the test the app, deploy prisma test db, and run the tests:
npm run --prefix server deploy:test or cd server && npm run deploy:test
npm run --prefix server test:docker
## Client
npm run --prefix client test:docker
```
## Commands
```sh
# server
* `npm run --prefix server build-types` To generate typescript client types from the graphql server. Ensure the app is running.
# client
* `npm run --prefix client test:docker` To test client
* `npm run --prefix client storybook:docker` To run storybook. Visit localhost:9009 to see it.
```