This guide will be using VS Code as the IDE, but you may use your preferred IDE.
Use the sample repository
We offer a sample repository that can be used as an educational resource. It is an Express API that can be run locally with sample
DELETE statements mapped to the proper API endpoints.
To follow along, you’ll need the following:
- A PlanetScale account, as well as knowing how to create a database.
- The PlanetScale CLI is installed on your computer, which will be used to seed data.
Start by creating a database in PlanetScale by clicking "New database" > "Create new database".
Name the database
travel_db. Click "Create database". Wait for the database to finish initializing before moving on.
Generate a set of credentials by clicking the "Get connection strings" button.
Select "@planetscale/database" from the options in the "Connect with" dropdown. Copy the text from the ".env" tab as we'll be putting this in the project after it's pulled down from GitHub.
When using the serverless JS driver, your host name will always be
aws.connect.psdb.cloud. You might notice this is slightly different from the regular PlanetScale connection strings, which are formatted as
On your workstation, open a terminal and clone the repository to your computer by running the following command:
git clone https://github.com/planetscale/database-js-starter
Navigate to the
scripts folder and run the
seed_database.sh script to populate a small database simulating a travel agency.
cd database-js-starter/scripts ./seed-database.sh
If you are using Windows, run this command through the Windows Subsystem for Linux (WSL)
Create a new file named
.env in the root of the project and paste in the sample provided from PlanetScale that you copied earlier.
To run the project, run the following commands from the root of the project.
npm install npm start
If the project is running properly, you should receive a message stating that the API is running.
tests.http file is designed to work with the VS Code Rest Client plugin, but can be used as a reference when testing with the tool of your choosing. If you are using the plugin, you may click the "Send request" button that appears above each request to see the API in action.
If you check the terminal where the API was started, the response from the
execute function is logged out for review.