Quickstart

Prerequisites

Running the starter kit requires you have to have node.js and yarn installed.

If you do not have these installed:

Install node.js for your operating system. The node installation will include npm.
Use npm to install yarn as described here.

Install & Run

Download the latest version of the starter kit from the Github Repository:

git clone git@github.com:neo4j-labs/neo4j-needle-starterkit.git

Navigate to the folder you just cloned and run the following commands to install and run the development server:

yarn install
yarn run dev

If all is successful, you will be shown the following message:

  VITE v4.5.1  ready in 125 ms

  ➜  Local:   http://localhost:3000/
  ➜  Network: use --host to expose
  ➜  press h to show help

View the application

Desktop

After starting the development server, use your browser to navigate to http://localhost:3000. The default app should look like this:

The same view using the dark theme:

Mobile

The Needle starter kit is responsive by default. The default app on mobile should look like this:

Next steps

After you have the starter app up-and-running, you can add in your own custom components and logic. See Components for the different components that can be customized.