techyrajeev / fullstack-apollo-express-postgresql-boilerplate

💥A sophisticated Apollo in React and Express boilerplate project.

Home Page:https://roadtoreact.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

fullstack-apollo-express-postgresql-boilerplate

Build Status Slack Greenkeeper badge

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.

This repository is the fullstack Apollo Server with Express and PostgreSQL project. You can find a working client application that can be used with this server in the list below:

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 git@github.com: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)
  • npm start
  • optional 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. 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: test:execute-test

Want to learn more about React + GraphQL + Apollo?

About

💥A sophisticated Apollo in React and Express boilerplate project.

https://roadtoreact.com

License:MIT License


Languages

Language:JavaScript 100.0%