Next.js + AWS Amplify + GraphQL Todo app ✅
A quick intro into AWS Amplify's CLI/API by building a super quick and easy Todo app using Next.js, AWS Amplify, GraphQL, and TailwindCSS.
Credits to Nader Dabit for doing this example in his book Full Stack Serverless. This book is a great way to get started with all things AWS and all that it has to offer. I recommend everyone check it out to understand Full Stack serverless web development using AWS. In his book he does this example in CRA but I'm gonna be using Next.js with my own little spin on it.
We are gonna get started by initializing a new Next project on our local machine.
You could also create and deploy a new project through Vercel's dashboard in literal minutes and clone it from your own repository. It's really great, Vercel does it all for you.
Note: You'll also want to make sure you have the amplify CLI installed. You can follow this tutorial here through Amplify's docs to walk you through it.
Next you'll want to initialize that the amplify project in your root directory of your project:
Next we are gonna add the GraphQL API
After that a file named schema.graphql should pop up in our VSCode terminal (assuming you're using VSCode)
From here we'll want to define the default schema for what we want out GraphQL API to look like and how it's gonna be stored.
Now we'll push all of our changes using "amplify push" in our terminal
After that finishes running we are all set up and now we can test our app be entering "amplify console api" in our terminal and then selecting "GraphQL" in our terminal.
Now we are able to verify that our newly deployed GraphQL endpoint has been setup correctly. We can do this by entering this into our console like this:
It then outputs the following:
Here is a screenshot of what that should look like:
The beautiful thing about GraphQL is that It gives us exactly as much or as little of it that we ask for when touching the endpoint. Now that we have created a Todo entry now we can query it in that same console and get this expected result:
Building the Application.
Last thing that we are going to add to our project is TailwindCSS. Now I decided to use TailwindCSS for this app but you can totally use whatever you want.
Note: If you need help walking through the full setup you can see TailwindCSS's full documentation on setting up with a Next.js project
From here the amplify CLI has automatically created mutations and queries for us based on our previously defined schema. From here we can easily add these into our app to make our simple todo app.
In our index.js file we are going to add all of the imports and configurations that we are going to need to for this app:
Because we are using Next.js we are able to use some of its powerful features. Instead of creating an isolated fetchTodos() function that'll run inside of a useEffect hook, we are going to use the getStaticProps() function that is native to the Next.js framework. In this function we are going to use one of the predefined queries in '../src/graphql/queries' to grab all of our todos and pass them in as props to our function that will render those in our app
For this action we are simply going to create an isolated function that will run when we create a new todo. This function will simply accept the todo and description values coming from the two input lines from our UI. We then create an object with those values in the shape of our schema that we defined for each Todo and query the GraphQL endpoint and console.log when it successfully gets created.
This action was one of my most favorite parts of building this app. The extent that we are going to "update" one of our todos is to mark if it has been completed or not. For this we are in a separate component that we have for each todo. In this component I am tracking the state of each todo entry and whether or not is has been marked as completed or not using the useState hook. Using the UpdateTodo mutation, we can set a specific todo marked as completed by the use of its unique id.
This part was a little tricky with understanding how to update state after performing the action but I figured it out. Similarly to the other queries we are going to use the DeleteTodo mutation to delete a todo based on its unique id.
Amplify is just one of the many services that AWS provides. I hope you gained a better understanding of how to execute CRUD operations and find a way to implement AWS amplify into your own projects!
Here is how my app turned out: