Overview
The GRANDstack Starter is a project starter for building a GRANDstack (GraphQL, React, Apollo, Neo4j Database) application. It consists of two components: the web frontend application (available in React and Angular flavors) and the API app (a GraphQL server). The starter is designed for creating a business reviews dashboard, but it can be customized for different use cases by adjusting the GraphQL schema, seed data, database index creation, and UI components.
Features
- GraphQL API application using Apollo Server and the Neo4j GraphQL Library.
- Frontend React web application with customizable UI components.
- Integration with Neo4j database for data storage.
- Support for creating a new project using the create-grandstack-app CLI tool.
- Option to seed the database with sample data.
- Ability to run the application locally and open it in a browser.
Installation
To install the GRANDstack Starter, follow these steps:
Create a Neo4j instance by either using the Neo4j Sandbox or Neo4j Desktop.
- For Neo4j Sandbox, sign in and create a new project by selecting the “Blank Sandbox” option. Use the connection credentials provided in the “Connection details” tab.
- For Neo4j Desktop, install Neo4j Desktop for your OS, create a new graph, and install the apoc plugin. Use the credentials you set during the setup.
Run the create-grandstack-app CLI tool or use Yarn to create a new directory with the GRANDstack Starter:
create-grandstack-app myNewApp
- (Optional) Seed the database with sample data by running the following command in a separate terminal:
npm start // or yarn start
npm run seedDB // or yarn run seedDB
- Open the application in a browser by running:
npm run start // or yarn start
Summary
The GRANDstack Starter is a project starter for building a GRANDstack application. It provides a GraphQL API and web frontend applications in React and Angular. With integration to a Neo4j database, the starter is designed for creating a business reviews dashboard. The installation guide provides step-by-step instructions for setting up and running the application.