https://github.com/the-road-to-graphql/fullstack-apollo-express-postgresql-boilerplate

💥 A sophisticated GraphQL with Apollo, Express and PostgreSQL boilerplate project.
https://github.com/the-road-to-graphql/fullstack-apollo-express-postgresql-boilerplate

apollo-client apollo-server apollo-server-express apollographql authentication authorization boilerplate fullstack postgres postgresql postgresql-boilerplate postgresql-database react react-apollo react-apollo-graphql reactjs starter-kit

Last synced: 7 days ago
JSON representation

💥 A sophisticated GraphQL with Apollo, Express and PostgreSQL boilerplate project.

• Host: GitHub
• URL: https://github.com/the-road-to-graphql/fullstack-apollo-express-postgresql-boilerplate
• Owner: the-road-to-graphql
• License: mit
• Created: 2018-05-07T02:50:31.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-06-12T08:43:37.000Z (over 4 years ago)
• Last Synced: 2024-10-16T07:41:36.071Z (21 days ago)
• Topics: apollo-client, apollo-server, apollo-server-express, apollographql, authentication, authorization, boilerplate, fullstack, postgres, postgresql, postgresql-boilerplate, postgresql-database, react, react-apollo, react-apollo-graphql, reactjs, starter-kit
• Language: JavaScript
• Homepage: https://roadtoreact.com
• Size: 2.93 MB
• Stars: 1,203
• Watchers: 26
• Forks: 263
• Open Issues: 44
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - fullstack-apollo-express-postgresql-boilerplate - road-to-graphql | 1113 | (JavaScript)

README

        
# fullstack-apollo-express-postgresql-boilerplate

[![Build Status](https://travis-ci.org/the-road-to-graphql/fullstack-apollo-express-postgresql-boilerplate.svg?branch=master)](https://travis-ci.org/the-road-to-graphql/fullstack-apollo-express-postgresql-boilerplate) [![Slack](https://slack-the-road-to-learn-react.wieruch.com/badge.svg)](https://slack-the-road-to-learn-react.wieruch.com/) [![Greenkeeper badge](https://badges.greenkeeper.io/the-road-to-graphql/fullstack-apollo-express-postgresql-boilerplate.svg)](https://greenkeeper.io/)

A full-fledged Apollo Server with Apollo Client starter project with React and Express. [Read more about it in this tutorial to build it yourself](https://www.robinwieruch.de/graphql-apollo-server-tutorial/).

**Family of universal fullstack repositories:**

Server Applications:

* [Node.js with Express + MongoDB](https://github.com/the-road-to-graphql/fullstack-apollo-express-mongodb-boilerplate)

* [Node.js with Express + PostgreSQL](https://github.com/the-road-to-graphql/fullstack-apollo-express-postgresql-boilerplate)

Client Applications:

* [React Client](https://github.com/the-road-to-graphql/fullstack-apollo-react-boilerplate)

* [React Native Client](https://github.com/morenoh149/fullstack-apollo-react-native-boilerplate)

## Features of Client + Server

* React (create-react-app) with Apollo Client

  * Queries, Mutations, Subscriptions

* Node.js with Express and Apollo Server

  * cursor-based Pagination

* PostgreSQL Database with Sequelize

  * entities: users, messages

* Authentication

  * powered by JWT and local storage

  * Sign Up, Sign In, Sign Out

* Authorization

  * protected endpoint (e.g. verify valid session)

  * protected resolvers (e.g. e.g. session-based, role-based)

  * protected routes (e.g. session-based, role-based)

* performance optimizations

  * example of using Facebook's dataloader

* E2E testing

## Installation

* `git clone [email protected]:the-road-to-graphql/fullstack-apollo-express-postgresql-boilerplate.git`

* `cd fullstack-apollo-express-postgresql-boilerplate`

* `touch .env`

* `npm install`

* fill out *.env file* (see below)

* start PostgreSQL database

* `npm start`

* visit `http://localhost:8000` for GraphQL playground

#### .env file

Since this boilerplate project is using PostgreSQL, you have to install it for your machine and get a database up and running. You find everything for the set up over here: [Setup PostgreSQL with Sequelize in Express Tutorial](https://www.robinwieruch.de/postgres-express-setup-tutorial). After you have created a database and a database user, you can fill out the environment variables in the *server/.env* file.

```

DATABASE=mydatabase

DATABASE_USER=postgres

DATABASE_PASSWORD=postgres

SECRET=asdlplplfwfwefwekwself.2342.dawasdq

```

The `SECRET` is just a random string for your authentication. Keep all these information secure by adding the *.env* file to your *.gitignore* file. No third-party should have access to this information.

#### Testing

* adjust `test:run-server` npm script with `TEST_DATABASE` environment variable in package.json to match your testing database name

  * to match it from package.json: `createdb mytestdatabase` with psql

* one terminal: npm run test:run-server

* second terminal: npm run test:execute-test

## Want to learn more about React + GraphQL + Apollo?

* Don't miss [upcoming Tutorials and Courses](https://www.getrevue.co/profile/rwieruch)

* Check out current [React Courses](https://roadtoreact.com)