typescript-sequelize-graphql-boilerplate: A TypeScript repository from ke-d

Running Locally

Prereq Software

Make sure you have Node.js 10.

Database

https://www.elephantsql.com
Sign up using GitHub and make a free PostgreSQL DB
Copy the URL link from the details tab into the .env variable below

Env Variables

Create a file named .env
Enter these variables in the file, replacing the <blah> with actual values

DATABASE_URL=postgres://<username>:<password>@<url>
CRYPTO_KEY=THISISASECRET

$ npm install
$ npm run dev

Your app should now be running on localhost:5000.

Go to /graphql

Creating a new Model for Sequalize/GraphQL

User.ts
...............................
  @Column // A column in the database
  public githubId!: string;

  @Field({ description: 'Username of the user' }) // Expose this variable to GraphQL
  @Column // A column in the database
  public username!: string;

  @Field({ description: 'The base value of their scores without any bonuses' }) // Expose this variable to GraphQL
  @Column // A column in the database
  public baseScore!: number;
...............................

So the convention (in this case), the top decorator is going to be the @Field if we are going to be exposing that variable to GraphQL.

The bottom decorator @Column is used for Sequalize, so it knows that variable should be a column in the DB.

TLDR:

Top Decorator: GraphQL

Bottom Decorator: Sequalize

These libraries were the only ones I found interacted well with each other with TypeScript.

Making a GraphQL Resolver (aka a controller)

@Resolver(User)
export default class UserResolver {
  @Query((returns) => User)
  public async user(@Arg('username') username: string) {
    const user = await User.find({
      where: { username },
    });
    if (!user) {
      throw new Error('User not found');
    }
    return user;
  }
}

Refer to these docs for making the resolver part

Refer to these docs for interacting with the DB with Sequalize