/appdev-week3-graphql

Workshop to illustrate how to use GraphQL

Primary LanguageJavaScript

🎓 Netflix Clone using Astra DB and GraphQL

Gitpod ready-to-code License Apache2 Discord

50 minutes, Intermediate, Start Building

A simple ReactJS Netflix homepage clone running on Astra DB that leverages a GraphQL API with paging and infinite scrolling. The materials has been built with the collaboration of Ania Kubow and Datastax developer advocates team.

image

🎯 Objectives

  • Deploy a Netflix clone to production
  • Learn GraphQL API and how to use it with a database to create the tables and navigate the data.
  • Learn about paging and infinite scrolling in web ui
  • Leverage Netlify and DataStax Astra DB

ℹ️ Frequently asked questions ℹ️

  • Can I run the workshop on my computer?

There is nothing preventing you from running the workshop on your own machine. If you do so, you will need

You will have to adapt commands and paths based on your environment and install the dependencies by yourself. We won't provide support to keep on track with schedule. However, we will do our best to give you the info you need to be successful.

  • What other prerequisites are there?
  • You will need a github account
  • You will also need Netlify and Astra DB accounts, but we'll work through that in the exercises
  • Use Chrome or Firefox for the best experience. Other browsers are great, but don't work well with the GitPod integration we use a bit later.
  • Do I need to pay for anything for this workshop?
  • No. All tools and services we provide here are FREE.
  • Will I get a certificate if I attend this workshop?

Attending the session is not enough. You need to complete the homeworks detailed below and you will get a nice badge.

Materials for the Session

It doesn't matter if you join our workshop live or you prefer to do at your own pace, we have you covered. In this repository, you'll find everything you need for this workshop:

Homework

Don't forget to complete your upgrade and get your verified skill badge! Finish and submit your homework!

  1. Complete the practice steps from this repository as described below.
  2. Insert a movie of your choice in the database.
  3. Make screenshots alongside the steps and show us your deployed production Netflix clone up in Netlify.
  4. (Optional extra credit) Watch the 2 hour Ania video HERE, build the app yourself, and show us the completed app.
  5. Submit your homework here

That's it, you are done! Expect an email next week!

Let's start

Table of contents

Part I - DB Setup & Data Ingest

  1. Create Astra DB Instance
  2. Create a security token
  3. Create table genre with GraphQL
  4. Insert data in genre with GraphQL
  5. Retrieve values of genre table
  6. Create movie table
  7. Insert values in movie table
  8. Retrieve values from movie table
  9. Load a CSV DataSet

Part II - Deploy to Production

  1. Deploy to Netlify
  2. Clone your GitHub repository
  3. Launch GitPod
  4. Install the Netlify CLI
  5. Retrieve application token to securely connect to the database
  6. Configure Environment Variables and Install Dependencies
  7. Launch your app
  8. Connect Netlify to your site
  9. Deploy to production

Extra resources

React starter using NPX

React ToDo app

What is JamStack?

Video tutorial with Ania Kubow

Part 1 - DB Setup & Data Ingest

1. Login or Register to AstraDB and create database

When creating your instance use the promotion code ANIA200 to get 200$ of free credit allowing you about 30 million writes + 30 Million reads + 50GB a month of monthly storage!!

ASTRADB is the simplest way to run Cassandra with zero operations at all - just push the button and get your cluster. No credit card required, $25.00 USD credit every month, roughly 5M writes, 30M reads, 40GB storage monthly - sufficient to run small production workloads.

Step 1a: Click the button to login or register with Datastax. You can use your Github, Google accounts or register with an email.

Make sure to chose a password with minimum 8 characters, containing upper and lowercase letters, at least one number and special character

  • Show me!

Use the following values when creating the database

Field Value
database name netflix_workshop_db
keyspace netflix_keyspace
Cloud Provider Use the one you like, click a cloud provider logo, pick an Area in the list and finally pick a region.

You can technically use whatever you want and update the code to reflect the keyspace. This is really to get you on a happy path for the first run.

You will see your new database pending in the Dashboard.

image

The status will change to Active when the database is ready, this will only take 2-3 minutes. You will also receive an email when it is ready.

🏠 Back to Table of Contents

2. Create a security token

Step 2a: Create a token for your app to use in the settings screen. Use "Database Administrator" permission.

Step 2b: Copy the token value (eg AstraCS:KDfdKeNREyWQvDpDrBqwBsUB:ec80667c....) in your clipboard and save the CSV, this value would not be provided afterward.

👁️ Expected output

  • Show me!

🏠 Back to Table of Contents

3. Create table genre with GraphQL

Step 3a: Open GraphQL Playground by

  1. Click on your active database
  2. Click Connect TAB
  3. Click GRAPHQL API
  4. Click link to your playground.

As show on the picture below. image

Note that values in the picture do no reflect the database name netflix_workshop_db, reason is we do not reproduce every picture each time

Step 3b: In GraphQL Playground, Populate HTTP HEADER variable x-cassandra-token on the bottom of the page with your token as shown below

image

Step 3c: In GraphQL Playground, create a table with the following mutation, making sure to replace netflix_keyspace if you used a different name:

  • Copy the following mutation on the left panel
mutation {
  reference_list: createTable(
    keyspaceName:"netflix_keyspace",
    tableName:"reference_list",
    ifNotExists:true
    partitionKeys: [ 
      { name: "label", type: {basic: TEXT} }
    ]
    clusteringKeys: [
      { name: "value", type: {basic: TEXT}, order: "ASC" }
    ]
  )
}
  • Use the arrow in the middle of the screen to execute the query

image

🏠 Back to Table of Contents

4. Insert data in the Table with GraphQL

Step 4a: In graphQL playground, change tab to now use graphql. Edit the end of the URl to change from system to the name of your keyspace: netflix_keyspace

Step 4b: Populate HTTP HEADER variable x-cassandra-token on the bottom of the page with your token as shown below (again !! yes this is not the same tab)

image

Step 4c: In GraphQL Playground,populate the reference_list table with the following values

  • Copy the following mutation on the left panel
mutation insertGenres {
  action: insertreference_list(value: {label:"genre", value:"Action"}) {
    value{value}
  }
  anime: insertreference_list(value: {label:"genre", value:"Anime"}) {
     value{value}
  }
  award: insertreference_list(value: {label:"genre", value:"Award-Winning"}) {
     value{value}
  }
  children: insertreference_list(value: {label:"genre", value:"Children & Family"}) {
     value{value}
  }
  comedies: insertreference_list(value: {label:"genre", value:"Comedies"}) {
     value{value}
  }
  documentaries: insertreference_list(value: {label:"genre", value:"Documentaries"}) {
     value{value}
  }
  drama: insertreference_list(value: {label:"genre", value:"Dramas"}) {
     value{value}
  }
  fantasy: insertreference_list(value: {label:"genre", value:"Fantasy"}) {
     value{value}
  }
  french: insertreference_list(value: {label:"genre", value:"French"}) {
     value{value}
  }
  horror: insertreference_list(value: {label:"genre", value:"Horror"}) {
     value{value}
  }
  independent: insertreference_list(value: {label:"genre", value:"Independent"}) {
     value{value}
  }
  music: insertreference_list(value: {label:"genre", value:"Music & Musicals"}) {
     value{value}
  }
  romance: insertreference_list(value: {label:"genre", value:"Romance"}) {
     value{value}
  }
  scifi: insertreference_list(value: {label:"genre", value:"Sci-Fi"}) {
     value{value}
  }
  thriller: insertreference_list(value: {label:"genre", value:"Thriller"}) {
     value{value}
  }  
}
  • Use the arrow in the middle of the screen to execute the query

🏠 Back to Table of Contents

5. Retrieving list of values

Step 5a: In GraphQL Playground, not changing tab (yeah) list values from the table with the following query.

query getAllGenre {
    reference_list (value: {label:"genre"}) {
      values {
      	value
      }
    }
}

👁️ Expected output image

🏠 Back to Table of Contents

6. Creating a Movies Table

Step 6a: Move to tab GRAPHQL-SCHEMA, everything should be set, use the following mutation to create a new table: _Remember to change the keyspaceName if you used something different.

mutation {
  movies_by_genre: createTable(
    keyspaceName:"netflix_keyspace",
    tableName:"movies_by_genre",
    ifNotExists: true,
    partitionKeys: [
      { name: "genre", type: {basic: TEXT} }
    ]
    clusteringKeys: [ 
      { name: "year", type: {basic: INT}, order: "DESC" },
      { name: "title", type: {basic: TEXT}, order: "ASC" }
    ]
    values: [
      { name: "synopsis", type: {basic: TEXT} },
      { name: "duration", type: {basic: INT} },
      { name: "thumbnail", type: {basic: TEXT} }
    ]
  )
}

👁️ Expected output image

🏠 Back to Table of Contents

7. Insert Values in Movie table

Step 7a: Move to tab GRAPHQL, everything should be set, use the following mutation to populate movies table:

mutation insertMovies {
  inception: insertmovies_by_genre(
    value: { 
      genre:"Sci-Fi", 
      year:2010,
      title:"Inception",
      synopsis:"Cobb steals information from his targets by entering their dreams.",
      duration:121,
      thumbnail:"https://i.imgur.com/RPa4UdO.mp4"}) {
    value{title}
    }
  
  prometheus: insertmovies_by_genre(value: { 
      genre:"Sci-Fi", 
      year:2012,
      title:"Prometheus",
      synopsis:"After a clue to mankind's origins is discovered, explorers are sent to the darkest corner of the universe.",
      duration:134,
      thumbnail:"https://i.imgur.com/L8k6Bau.mp4"}) {
    value{title}
    }
  
  	aliens: insertmovies_by_genre(value: { 
      genre:"Sci-Fi", 
      year:1986,
      title:"Aliens",
      synopsis:"Ellen Ripley is sent back to the planet LV-426 to establish contact with a terraforming colony.",
      duration:134,
      thumbnail:"https://i.imgur.com/QvkrnyZ.mp4"}) {
    value{title}
    }
  
    bladeRunner: insertmovies_by_genre(value: { 
      genre:"Sci-Fi", 
      year:1982,
      title:"Blade Runner",
      synopsis:"Young Blade Runner K's discovery of a long-buried secret leads him to track down former Blade Runner Rick Deckard.",
      duration:145,
      thumbnail:"https://i.imgur.com/xhhvmj1.mp4"}) {
    value{title}
    }
  }

👁️ Expected output image

ℹ️ You can find more movie data in the data folder, however, we will be doing a bulk import of all this data shortly.

🏠 Back to Table of Contents

8. Retrieve values from Movie tables

Step 8a: In GraphQL Playground, not changing tab (yeah) list values from the table with the following command.

query getMovieAction {
    movies_by_genre (
      value: {genre:"Sci-Fi"},
       orderBy: [year_DESC]) {
      values {
        year,
        title,
        duration,
        synopsis,
        thumbnail
      }
    }
}

👁️ Expected output image

Step 8b Enable paging: For small datasets you can retrieve all values in the table but for performance or network reasons you need to perform paging. Let's do same query as before now asking for a page size to 2

query getMovieAction {
    movies_by_genre (
      value: {genre:"Sci-Fi"},
       options: {pageSize: 2},
       orderBy: [year_DESC]) {
      values {
        year,
        title,
        duration,
        synopsis,
        thumbnail
      }
    pageState
    }
}

👁️ Expected output

image

Step 8c: Fetch next page paging: Notice that pageState is also now returned. Let's use it to fetch the next 2 items (next page). Edit the next query to replace your own pageState YOUR_PAGE_STATE

query getMovieAction {
    movies_by_genre (
      value: {genre:"Sci-Fi"},
       options: {pageSize: 2, pageState: "<YOUR_PAGE_STATE>"},
       orderBy: [year_DESC]) {
      values {
        year,
        title,
        duration,
        synopsis,
        thumbnail
      }
    pageState
    }
}

👁️ Expected output

image

🏠 Back to Table of Contents

9. Load a CSV DataSet

Step 9a: Download the dataset

To download the DATASET, right-click (or CTRL + Click to open in new tab) the button below and download the target file on your machine.

If the file opens in the browser save it with the name movies_by_genre.csv. This is important as the filename will be the table name.

Step 9b: Open Astra Data Loader Importer

  • Locate the Load Data button to open the Data Loader.

image

Step 9c: Upload the dataset

Click on the area Drag n drop a single file and look for the file movies_by_genre.csv on your machine, this file has been downloaded in step 9b.

image

Once the file has been upload notive the Upload Successful message in green. You can now click NEXT

Step 9d: Define target table

  • Locate the field Table Name and make sure it is set to movies_by_genre

image

  • In Keys and Clustering section enter genre as the partition key.

image

You can now click on NEXT to move forward.

Step 9e: Define target database

image

Select the database we are currently using:

Field Value
Target Database netflix_workshop_db
Target Keyspace netflix_keyspace

and click next to start the process asynchronously.

Step 9f: Wait for the batch to import your data

After a few seconds (about 30s) ,you will get an email informing you that the batch has been scheduled.

image

As you can see the operation here is asynchronous. About a minute later your will get another email to tell you the data has been inserted.

image

Congratulations the Database is SET !!!

🏠 Back to Table of Contents

Part 2 - Deploy to Production

1. Deploy to Netlify

  • What does the netlify deploy button do?The Netlify deploy button will:
    • Create a new repository for you on Github
    • Create a site on Netlify
    • Link the two together.
  • Click the button to deploy

    Deploy to Netlify

  • Show me!

This will take a few minutes.

  • Click on Site deploy in progress within the Netlify UI,

    Show me!
  • Click the top deploy link to see the build process.

    Show me!
  • Wait until the build complete Netlify Build Complete, When you see Pushing to repository you're ready to move on.

    Show me!
  • Scroll up to the top and click on the site name (it'll be after {yourlogin}'s Team next to the Netlify button).

    Show me!

2. Access your GitHub repository

  • Click on the GitHub in Deploys from GitHub to get back to your new repository. Scroll to where you were in the README.
    Show me!

3. Launch GitPod IDE

  • Click the button to launch the GitPod IDE from YOUR repository.
  • Supported by Chrome and Firefox

WAIT! Before moving on ensure you are working out of YOUR repository, not the datastaxdevs repository.

correct notcorrect

If you are still using the datastaxdevs repo please ensure to follow the previous step, step3 to get to your repo.

  • Ok, I've got it, just give me the button already

  • CLICK HERE to launch GitPod

    Open in Gitpod

ℹ️ It may take minutes (approx. 3-5) for GitPod to fully initialize.

(Note: if the Gitpod button does not work, for example you are using Safari, don't despair! You can manually build the URL you need and open it in a new tab like this: https://gitpod.io/#<YOUR REPO FULL URL>, pasting in it the full address of your GitHub repository. For example, https://gitpod.io/#https://github.com/JohnSmith/my-netflix.clone, assuming your are "JohnSmith" on Github and your repo is "my-netflix-clone").

WAIT! Before moving on ensure you are working out of YOUR repository, not the datastaxdevs repository.

  • From your GitPod terminal execute the following command
git remote -v

If the result returned from the command displays datastaxdevs then you are not in the correct repository. If this is the case please repeat step 2 above, otherwise just move on to the next step.

4. Install the Netlify CLI (Command Line Interface)

  • In the appdev-week3-graphql directory run the following command to install the netlify-cli
npm install -g netlify-cli
  • Show me!

5. Retrieve application token to securely connect to the database

Use the token you previously generated. If you no longer have the token and did not download a .csv, you can generate a new token using the instructions above

You will also need the GraphQL Endpoint for your keyspace. First, go to the Astra DB connect page for your database. graphql-endpoint-1 Then scroll down to find the endpoint for your keyspace. graphql-endpoint-1

6. Configure Environment Variables and Install Dependencies

✅ Create .env file (do not leave curly brackets)

ASTRA_DB_APPLICATION_TOKEN={ your_token }
ASTRA_GRAPHQL_ENDPOINT={ your_endpoint }

env-file

👩‍💻 Install all the packages

npm install

7. Launch your app

  • Run the application
netlify dev
  • The application should automatically launch in the GitPod preview pane

8. Connect Netlify to your site

Execute each of the commands below to link your code to your Netlify deployment.

Step 8a: we'll need to STOP the netlify dev command we issued a moment ago. In the terminal where you executed the netlify command issue a CTRL+C (control key + the C key) in order to stop the process.

Step 8b: Enter the following command to pop up a browser to authenticate with netlify

netlify login

👁️ Expected output

Opening https://app.netlify.com/authorize?....
⠋ Waiting for authorization...^C

Step 8c: Open the link in a new WINDOW for the link to work, and authorize Netlify CLi to access Netlify on your behalf.

When using GitPod the preview pane will not display this properly. You must click the "open in a new window" button in the very top right of the preview pane._

👁️ Expected output

You are now logged into your Netlify account!
Run netlify status for account details
To see all available commands run: netlify help
gitpod /workspace/appdev-week3-graphql $ 

Step 8d: link your workspace to the associated site with the following command

netlify link

👁️ Expected output

image

Step 8e: take the .env file upload it to netlify

netlify env:import .env

9. Deploy to production

Now that you've hooked everything up, time to deploy to production.

  • Run
netlify build
  • Then run
netlify deploy --prod
  • Then finally run
netlify open:site

You've deployed your app to Netlify! Netlify Setup Example

Extra resources

Video tutorial with Ania Kubow

Thank you to our wonderful friend Ania Kubow for producing the Netflix clone. If you are not aware of Ania and love learning about coding you should absolutely check out her YouTube channel listed below.

While we focused on getting you up and running to production with Astra DB and Netlify, Ania's video will dig into more details on the app itself. Check it out to dig in more.

Ania's Netflix Video