🍀 Yotsuba API

A GraphQL API wrapper for 4chan built with Apollo Data Sources.

🛠️ Setup

Install dependencies by running yarn. That's it!

If you want to track usage metrics for your API, you'll need to get an API key from Apollo Graph Manager. For instructions on how to do that, please read the Apollo Graph Manager docs. Then create a new file in the root directory named .env. In it, copy + paste the following and replace the text following the = sign with your newly create API key.

ENGINE_API_KEY=<insert your apollo graph manager api key here>

Once that's done, you can now start up a development server using yarn start. By default this will use Serverless Offline, but if you would instead like to use Netlify Lamba, you can run yarn start:netlify instead. Once the development server is listening, you can pull up a GraphQL Playground by visiting one of the following URLs:

Lambda: http://localhost:1337/dev Netlify: http://localhost:1337/.netlify/functions/yotsuba-api

🕹️ Demo

You can try out the API using the GraphQL Playground hosted at https://yotsuba-api.saeris.io/.netlify/functions/yotsuba-api

🧪 Testing

Testing is provided via jest and is pre-configured to run with codecov as well. While tests for this project are far from complete, they can be found under src/__TEST__ and follow a naming format of [filename].spec.ts. Additionally, this project uses eslint, typescript, and prettier, all three of which are automatically run on each commit via husky + lint-staged. To manually lint and test, use the following commands:

Lint:

yarn lint

Typecheck:

yarn typecheck

Test and watch for changes:

yarn test:watch

Lint + Typecheck + Test:

yarn test

🚢 Deployment

To deploy the server, you'll need to follow the Serverless Framework's Setup Guide to deploy to AWS. If you'd rather use Netlify, you'll need to follow whichever method works best for your workflow. Refer to Netlify's Docs for more information.

If you're deploying to AWS, you can use the following commands to deploy to Staging or Production:

Staging:

yarn deploy

Production:

yarn deploy:prod

Alternatively, if you're using Travis CI, you can deploy to both on each commit as part of your CI process by uncommenting the following lines inside travis.yml:

deploy:
 # deploy develop to the staging environment
 - provider: script
   skip_cleanup: true
   script: yarn deploy:dev
   on:
     node: "12"
     branch: develop
 # deploy master to production
 - provider: script
   skip_cleanup: true
   script:
     - yarn deploy:prod
   on:
     node: "12"
     branch: master

🥂 License

Released under the MIT license.