IT4Change/Ocelot-Social
3
0
Fork 0
mirror of https://github.com/IT4Change/Ocelot-Social.git synced 2025-12-13 07:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge installation with backend installation

Browse Source
This commit is contained in:
Robert Schäfer 2019-04-14 23:45:35 +02:00
parent 51f0142e7f
commit 6796469c9c
2 changed files with 108 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

176
backend/README.md
View File

@ -1,137 +1,155 @@
# Backend # Backend
## Installation
{% tabs %}
{% tab title="Docker" %}
## Installation with Docker Run the following command to install everything through docker.
Make sure you are on a [node](https://nodejs.org/en/) version >= `v10.12.0`: The installation takes a bit longer on the first pass or on rebuild ...
```text
node --version
```
Run:
```bash ```bash
docker-compose up $ docker-compose up
# create indices etc. # rebuild the containers for a cleanup
docker-compose exec neo4j migrate $ docker-compose up --build
# if you want seed data
# open another terminal and run
docker-compose exec backend yarn run db:seed
``` ```
Open another terminal and create unique indices with:
App is [running on port 4000](http://localhost:4000/)
To wipe out your neo4j database run:
```bash ```bash
docker-compose down -v $ docker-compose exec neo4j migrate
``` ```
## Installation without Docker {% endtab %}
Install dependencies: {% tab title="Without Docker" %}
For the local installation you need a recent version of [node](https://nodejs.org/en/)
(>= `v10.12.0`) and [Neo4J](https://neo4j.com/) along with
[Apoc](https://github.com/neo4j-contrib/neo4j-apoc-procedures) plugin installed
on your system.
Download [Neo4j Community Edition](https://neo4j.com/download-center/#releases) and unpack the files. Download [Neo4j Community Edition](https://neo4j.com/download-center/#releases) and unpack the files.
Download [Neo4j Apoc](https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases) and drop the file into the `plugins` folder of the just extracted Neo4j-Server Download [Neo4j Apoc](https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases) and drop the file into the `plugins` folder of the just extracted Neo4j-Server
Note that grand-stack-starter does not currently bundle a distribution of Neo4j. You can download [Neo4j Desktop](https://neo4j.com/download/) and run locally for development, spin up a [hosted Neo4j Sandbox instance](https://neo4j.com/download/), run Neo4j in one of the [many cloud options](https://neo4j.com/developer/guide-cloud-deployment/), [spin up Neo4j in a Docker container](https://neo4j.com/developer/docker/) or on Debian-based systems install [Neo4j from the Debian Repository](http://debian.neo4j.org/). Just be sure to update the Neo4j connection string and credentials accordingly in `.env`.
Start Neo4J and confirm the database is running at [http://localhost:7474](http://localhost:7474).
Start Neo4j Now install node dependencies with [yarn](https://yarnpkg.com/en/):
```bash
```text # in 'Human-Connection/'
neo4j\bin\neo4j start $ yarn install
$ cd backend && yarn install
$ cd ../webapp && yarn install
$ cd ..
``` ```
and confirm it's running [here](http://localhost:7474) Copy Environment Variables:
```bash
$ cp cypress.env.template.json cypress.env.json
$ cp backend/.env.template backend/.env
$ cp webapp/.env.template webapp/.env
```
Configure the new files according to your needs and your local setup.
Create unique indices with:
```bash ```bash
yarn install $ ./neo4j/migrate.sh
# -or-
npm install
``` ```
Copy: Start the backend for development with:
```text
cp .env.template .env
```
Configure the file `.env` according to your needs and your local setup.
Start the GraphQL service:
```bash ```bash
yarn dev $ yarn run dev
# -or-
npm dev
``` ```
And on the production machine run following: or start the backend in production environment with:
```bash ```bash
yarn start yarn run start
# -or-
npm start
``` ```
This will start the GraphQL service \(by default on localhost:4000\) where you can issue GraphQL requests or access GraphQL Playground in the browser: {% endtab %}
{% endtabs %}
Your backend is up and running at [http://localhost:4000/](http://localhost:4000/)
This will start the GraphQL service \(by default on localhost:4000\) where you can issue GraphQL requests or access GraphQL Playground in the browser.
![GraphQL Playground](../.gitbook/assets/graphql-playground.png) ![GraphQL Playground](../.gitbook/assets/graphql-playground.png)
## Configure You can access Neo4J through [http://localhost:7474/](http://localhost:7474/)
for an interactive `cypher` shell and a visualization of the graph.
Set your Neo4j connection string and credentials in `.env`. For example:
_.env_ #### Seed Database
```yaml If you want your backend to return anything else than an empty response, you
NEO4J_URI=bolt://localhost:7687 need to seed your database:
NEO4J_USERNAME=neo4j
NEO4J_PASSWORD=letmein
```
> You need to install APOC as a plugin for the graph you create in the neo4j desktop app! {% tabs %}
{% tab title="Docker" %}
Note that grand-stack-starter does not currently bundle a distribution of Neo4j. You can download [Neo4j Desktop](https://neo4j.com/download/) and run locally for development, spin up a [hosted Neo4j Sandbox instance](https://neo4j.com/download/), run Neo4j in one of the [many cloud options](https://neo4j.com/developer/guide-cloud-deployment/), [spin up Neo4j in a Docker container](https://neo4j.com/developer/docker/) or on Debian-based systems install [Neo4j from the Debian Repository](http://debian.neo4j.org/). Just be sure to update the Neo4j connection string and credentials accordingly in `.env`.
# Seed and Reset the Database
Optionally you can seed the GraphQL service by executing mutations that will write sample data to the database:
In another terminal run:
```bash ```bash
yarn run db:seed $ docker-compose exec backend yarn run db:seed
# -or-
npm run db:seed
``` ```
For a reset you can use the reset script: To reset the database run:
```bash ```bash
yarn db:reset $ docker-compose exec backend yarn run db:reset
# -or- # you could also wipe out your neo4j database and delete all volumes with:
npm run db:reset $ docker-compose down -v
``` ```
{% endtab %}
{% tab title="Without Docker" %}
Run:
```bash
$ yarn run db:seed
```
To reset the database run:
```bash
$ yarn run db:reset
```
{% endtab %}
{% endtabs %}
# Testing # Testing
**Beware**: We have no multiple database setup at the moment. We clean the database after each test, running the tests will wipe out all your data! **Beware**: We have no multiple database setup at the moment. We clean the database after each test, running the tests will wipe out all your data!
{% tabs %}
{% tab title="Docker" %}
Run the _**jest**_ tests: Run the _**jest**_ tests:
```bash ```bash
yarn run test $ docker-compose exec backend yarn run test:jest
# -or-
npm run test
``` ```
Run the _**cucumber**_ features: Run the _**cucumber**_ features:
```bash ```bash
yarn run test:cucumber $ docker-compose exec backend yarn run test:cucumber
# -or-
npm run test:cucumber
``` ```
When some tests fail, try `yarn db:reset` and after that `yarn db:seed`. Then run the tests again {% endtab %}
{% tab title="Without Docker" %}
Run the _**jest**_ tests:
```bash
$ yarn run test:jest
```
Run the _**cucumber**_ features:
```bash
$ yarn run test:cucumber
```
{% endtab %}
{% endtabs %}

82
installation.md
View File

@ -33,14 +33,18 @@ $ cd Human-Connection
## Directory Layout ## Directory Layout
There are four important directories: There are four important directories:
* [Backend](./backend) runs on the server and serves as a middleware to the database * [Backend](./backend) runs on the server and is a middleware between database and frontend
* [Frontend](./webapp) server-side and client-side rendered application * [Frontend](./webapp) is a server-side-rendered and client-side-rendered web frontend
* [Deployment](./deployment) contains configuration for kubernetes deployments * [Deployment](./deployment) configuration for kubernetes
* [Cypress](./cypress) end-to-end tests with cypress * [Cypress](./cypress) contains end-to-end tests and executable feature specifications
In order to setup the application you have to setup the frontend and backend In order to setup the application and start to develop features you have to
either locally on your system or you can also use our provided docker setup **frontend** and **backend**.
installation.
There are two approaches:
1. Local installation, which means you have to take care of dependencies yourself
2. **Or** Install everything through docker which takes care of dependencies for you
## Docker Installation ## Docker Installation
@ -75,68 +79,4 @@ $ docker-compose --version
docker-compose version 1.23.2 docker-compose version 1.23.2
``` ```
### Installation with Docker
Run the following command to install Nitro as a Docker container. This installation includes Neo4j.
The installation takes a bit longer on the first pass or on rebuild ...
```bash
$ docker-compose up
# rebuild the containers for a cleanup
$ docker-compose up --build
```
#### Seed Database
To seed the Neo4j database with default data, that GraphQL requests or playing with our GraphQL Playground returns anything else than an empty response, run the command.
Run the following command to seed the Neo4j database with default data requested by Nitro-Web through GraphQL or when you play with our GraphQL playground.
```bash
# open another terminal
# create indices etc.
$ docker-compose exec neo4j migrate
# seed database
$ docker-compose exec backend yarn run db:seed
```
**Wipe out Neo4j database in Docker**
To wipe out your neo4j database and delete the volumes send command:
```bash
# open another terminal and run
$ docker-compose down -v
```
**Video Tutorial**
{% hint style="info" %}
TODO: Link to video
{% endhint %}
## Local Installation
#### Install the dependencies
```bash
$ yarn install
$ cd backend && yarn install
$ cd ../webapp && yarn install
$ cd ..
```
#### Copy Environment Variables
```bash
$ cp cypress.env.template.json cypress.env.json
$ cp backend/.env.template backend/.env
$ cp webapp/.env.template webapp/.env
```
Configure the new files according to your needs and your local setup.