A sample Node.js application that uses the database-js package.

Last update: Dec 19, 2022

Related tags

Overview

database-js-starter

A sample Node.js Express API built using the PlanetScale serverless driver for JavaScript. It contains sample API endpoints that can be used to map to various operations on your PlanetScale database:

API Method	SQL Action
`GET`	`SELECT`
`POST`	`INSERT`
`PUT`	`UPDATE`
`DELETE`	`DELETE`

The main goal of this sample is to be used to gain an understanding of how to use the serverless driver in your own code.

For an in-depth explanation of how to use this repo, check the associated article on the PlanetScale docs site.

Set up the database

Before you can start the project, you should set up a database that can be used with the project. Create a database on PlanetScale named travel_db. Once the database has initialized, run the following command to create the necessary structures for the database and insert the sample dataset:

cd scripts
./seed-database.sh

Start the API

To use the project, clone the repository down to your workstation and run the following commands:

npm install
npm start

You should receive a message stating that the API is running.

Test the API

The tests.http file can be used to test the various endpoints. It is designed to be used with the VS Code Rest Client plugin, although it can also be used as a reference in testing with alternate tools.

A sample Node.js application that uses the database-js package.

Related tags

Overview

database-js-starter

Set up the database

Start the API

Test the API

Further reading

You might also like...

Sample code for ETH Sign In

Sample of CI/CD auto deploy to own server via Github Actions

Sample code of UI projects for SAP BTP Launchpad Service.

NestJS + AWS SQS sample

JavaScript Express.js app serving static vanilla JS. This sample app is used in Microsoft Docs to demonstrate how to integrate Azure Storage, Azure Cosmos DB, and Azure Active Directory.

Utility for authorizing user in a connected app, creating JWT to authenticate against it, and perform a sample callout.

A sample CICD Deployment Pipeline for your Alexa Skills, using AWS CDK, CodeBuild and CodePipeline

Textme.lk SMS SDK and Sample Apps

Serverless Framework + typescript + mongoDB atlas, sample

Comments

fetch is note a function

Owner

PlanetScale

Package fetcher is a bot messenger which gather npm packages by uploading either a json file (package.json) or a picture representing package.json. To continue...

Short sample and instructions for configuring a Flutter Web application to deploy-on-push to Firebase Hosting

Multi-platform node package bundle to a package.json.

Script to synchronize between a Notion database and Google Calendar both ways. Uses Google App Script.

A high-resolution local database that uses precise algorithms to easily record data in local files within a project with persistent JSON and YAML support designed to be easy to set up and use

Interplanetary Database: A Database built on top of IPFS and made immutable using Ethereum blockchain.

Visualize, modify, and build your database with dbSpy! An open-source data modeling tool to facilitate relational database development.

Blog application api in Node.js express.js sequelize ORM and MYSQL Database

A package to manage cron-jobs in a node.js Typescript application.

This package is for developers to be able to easily integrate bad word checking into their projects.\r This package can return bad words in array or regular expression (regex) form.