React Starter GraphQL API

How that does work

• PostgresQL schema -> Postgraphile -> GraphQL API

or:

• PostgresQL schema -> PostgREST -> REST API

or:

• PostgresQL schema -> REST API -> GraphQL -> GraphQLAPI (not implemented)

Features

• Benchmarking along with the tests.
• User management system (through JWT).
• Referral system
• CMS system (??)
• payment system (??)
• Blockchain functions (??)
• Newsletter management (???)

TODO

• JWT verify.
• oauth signup/signin
• ref sys
• cms sys

How to prepare

npm i

• Create database.
• Edit .env or .env.development
• Modify schema inside db/createTables.js if needed.
• Create tables:

cd db/
node createTables.js

How to start

Run API server

npm install -g postgraphile
postgraphile -c postgres://postgres:[email protected]:5432/blue -j --watch

# For all CLI options:
# https://www.graphile.org/postgraphile/usage-cli/

# OR:
npm run start

Run Postgres PubSub service:

cd utils/
node pubsub.js
# OR:
npm run pubsub

OR use build.sh

Use Postgres on Docker

# Install and run:
./postgres_docker.sh container_name postgres_password

# Connect to:
psql -h 0.0.0.0 -p 5432 -U postgres

Use Postgraphile on Docker

./graphile_docker.sh name_of_container postgres_password database_name port

Use PostgREST

Edit postgrest.conf, then:

./postgrest_install.sh
./gen_pass.sh
./postgrest postgrest.conf

Generate docs

./docs.sh project_name

Example GraphQL requests

Signup

mutation {
  signup(input: {email: "[email protected]", password: "123456"}) {
    clientMutationId
  }
}

Signin

mutation {
  login(input: {email: "[email protected]", password: "123456"}) {
    json
  }
}

Validate

mutation {
  validate(input: {tok: "fbd10f39-88cf-4850-b599-8df0b43aa2ac"}) {
    clientMutationId
  }
}

Update user

mutation {
  updateUserInfo(input: {mail: "[email protected]", password: "123456", firstname: "First", lastname: "Last", about: "About me"}) {
    clientMutationId
  }
}

Delete user

mutation {
  deleteUserAccount(input: {mail: "[email protected]", password: "123456"}) {
    clientMutationId
  }
}

Password reset

mutation {
  requestPasswordReset(input: {email: "[email protected]"}) {
    clientMutationId
  }
}

mutation {
  resetPassword(input: {email: "[email protected]", token: "1644a2aa-ded2-47f3-945c-e79399015dc7", password: "65321"}) {
    clientMutationId
  }
}

Tests

1. Create test database and edit appropirate .env file.
2. Graphile API and pubsub listener should be running.
3. Then:

npm run test

Licence

MIT