Skip to content

readme.setup.md

Latest commit

 

History

History
48 lines (33 loc) · 1.78 KB

readme.setup.md

File metadata and controls

48 lines (33 loc) · 1.78 KB
Raw

Application set up Guide

To get the application up and run, below are a few steps you will need to do in order to have it run. This project uses neo4j for the database and NestJS for the API.

Setup neo4j

Nest Logo

neo4j, like I mentioned before is being used for long term data storage and currently is just being hosted off my laptop. It could easily be put into a docker container or wherever, it's up to you to decide that.

I recommend installing Neo4j Desktop

Steps:

  1. Launch Neo4j Desktop
  2. Create a new project
    1. I called mine "Mammoth" with Neo4j v4.x
  3. Add a new Graph (I again called mine Mammoth) with password "mammoth"
    1. You can change the password to whatever you want just update neo4j.module.ts in the api folder
  4. That's really all you need to do to setup Neo4j simple and easy.
  5. One quick gotcha is to make sure you click "Start" on your graph or else the API has nothing to talk to.

Setup NestJS

Nest Logo

NestJS will actually be set up for you after you run npm install however, NestJS also has a very good CLI

-> npm i -g @nestjs/cli

Angular Setup

Nest Logo

Angular will also be set up for you by default, nothing needs to be done there. Angular also ships with a CLI