Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/benawad/create-graphql-api

Set up a Typescript GraphQL API by running one command.
https://github.com/benawad/create-graphql-api

graphql postgresql typescript

Last synced: 1 day ago
JSON representation

Set up a Typescript GraphQL API by running one command.

Awesome Lists containing this project

README

        

# create-graphql-api

```
npx create-graphql-api my-api
cd my-api
npm start
```

## Example

Basic: https://www.youtube.com/watch?v=WhzIjYQmWvs

Auth: https://www.youtube.com/watch?v=OVdPOExxKuU

## Templates

You can do the following for an auth template:

```
npx create-graphql-api my-api --auth
```

## How to Deploy to Heroku

0. Make sure you have Git setup
1. Setup Heroku CLI: https://devcenter.heroku.com/articles/getting-started-with-nodejs#set-up
2. Create a `Procfile` in the root folder of your project and put the following in it:
```
web: node dist/index.js
```
3. In your `package.json` add the following script to run the TypeScript compiler before Heroku runs your project:
```
"heroku-postbuild": "tsc"
```
4. In the root folder of your project, use the Heroku CLI to create a new project:
```
heroku create
```
5. Add a PostgreSQL database addon
```
heroku addons:create heroku-postgresql
```
6. Commit your code and push to Heroku
```
git push heroku master
```

Note: You'll want to look at your `ormconfig.js` and configure the options you want for production.

Also see this video on how you can deploy to Digital Ocean with Dokku: https://www.youtube.com/watch?v=AdHwBKKQHZ4