mzikherman / kaws

API for collections, our SEO optimized marketing landing pages

kaws

Named after the artist, kaws is a backend service that powers artsy.net collection pages. What are collections you ask? A Collection is a prefiltered version of Artsy's Collect page for marketing purposes.

• State: in development
• Production: http://kaws.artsy.net | k8s
• Staging: http://kaws-staging.artsy.net | k8s
• GitHub: https://github.com/artsy/kaws/
• CI: CircleCI; merged PRs to artsy/kaws#master are automatically deployed to staging. PRs from staging to release are automatically deployed to production. Start a deploy...
• Point People: @l2succes

Prerequisites

• node.js 8.12.0 or newer
• yarn 1.10.1 or newer
• MongoDB 4.x

Getting started

First, make sure to install dependencies:

yarn

We use the .env file to load environment-specific variables. Copy .env.example to .env so dotenv will automatically load them upon app boot:

cp .env.example .env

Usually you do not have to change them, but if you need, update the variables to match your local development setup.

Once this is done, the next step would be to load test data. This repository also hosts fixtures that could be used in development. Try running the command below to load the fixture data to your local MongoDB instance:

yarn bootstrap-data

As of writing, this command doesn't exit automatically. You can kill the process once you confirm the data is in the db.

Finally, start the server by running the command below:

yarn dev

Then open http://localhost:4000/playground and you should see Apollo's GraphQL Playground. Try running the GraphQL query below, and if you see "KAWS, Companions" and "Pablo Picasso, Lithographs" you are good to go!

query {
  collections {
    id
    slug
    title
  }
}

Testing

yarn jest