From f2958b9c2b5308c4e17c4aa66b149d664e9553fa Mon Sep 17 00:00:00 2001 From: Schroeer Date: Sun, 6 Dec 2020 16:03:26 +0000 Subject: [PATCH 1/2] updated info for local dev setup --- docs/development-local.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/docs/development-local.md b/docs/development-local.md index 53d7277..d242d4a 100644 --- a/docs/development-local.md +++ b/docs/development-local.md @@ -1,9 +1,32 @@ # Local Development Guide - +## Local Setup +Prerequisites: +- Node.js (https://nodejs.org/en/) +- Neo4j (https://neo4j.com/) +- Facebook dev account (https://developers.facebook.com/) + +Steps: + +1. open Neo4j and create database +2. go to facebook dev portal and create new app to obtain `APP_ID` and `SECRET` +3. fork and clone repository +4. open directory and install npm packages +```ts +cd slackmap +npm install +``` +5. rename `.env.sample` file to `.env` +6. update `.env` file with Neo4j and facebook info +7. serve angular app ```ts -// if you want to share the dev server in local network, for mobile debugging -ng serve web --port 0.0.0.0 +ng serve web ``` +8. open another terminal window and serve api +```ts +ng serve api +``` + +## Introduction to used tools ### Neo4j From 7e40abfefbe177fe668ac8cff65cf85573b05321 Mon Sep 17 00:00:00 2001 From: Schroeer Date: Sun, 13 Dec 2020 17:46:37 +0000 Subject: [PATCH 2/2] added angular cli to list --- docs/development-local.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/development-local.md b/docs/development-local.md index d242d4a..20f4042 100644 --- a/docs/development-local.md +++ b/docs/development-local.md @@ -2,6 +2,7 @@ ## Local Setup Prerequisites: - Node.js (https://nodejs.org/en/) +- Angular CLI (https://cli.angular.io) - Neo4j (https://neo4j.com/) - Facebook dev account (https://developers.facebook.com/)