mirror of
https://github.com/IT4Change/Ocelot-Social.git
synced 2026-04-05 17:15:33 +00:00
GitBook: [master] 38 pages modified
This commit is contained in:
Grzegorz Leoniec
gitbook-bot
parent
b6906e3708
commit
768eb1c4c0
@ -1,7 +1,3 @@
|
||||
---
|
||||
description: Welcome to the Human-Connection Nitro Documentation.
|
||||
---
|
||||
|
||||
# Let's change the World
|
||||
|
||||
## Why do we need HC Nitro?
|
||||
|
||||
36
SUMMARY.md
36
SUMMARY.md
@ -4,30 +4,30 @@
|
||||
|
||||
## Backend
|
||||
|
||||
* [Backend Installation](api/installation/README.md)
|
||||
* [Configuration](api/installation/configuration.md)
|
||||
* [Docker](api/installation/docker.md)
|
||||
* [GraphQL with Apollo](api/graphql-with-apollo/README.md)
|
||||
* [Mocking](api/graphql-with-apollo/mocking.md)
|
||||
* [Seeding](api/graphql-with-apollo/seeding.md)
|
||||
* [Middleware](api/middleware.md)
|
||||
* [Import](api/data-import.md)
|
||||
* [Todo's](api/todos.md)
|
||||
* [Backend Installation](backend/installation/README.md)
|
||||
* [Configuration](backend/installation/configuration.md)
|
||||
* [Docker](backend/installation/docker.md)
|
||||
* [GraphQL with Apollo](backend/graphql-with-apollo/README.md)
|
||||
* [Mocking](backend/graphql-with-apollo/mocking.md)
|
||||
* [Seeding](backend/graphql-with-apollo/seeding.md)
|
||||
* [Middleware](backend/middleware.md)
|
||||
* [Import](backend/data-import.md)
|
||||
* [Todo's](backend/todos.md)
|
||||
|
||||
## Web Frontend
|
||||
|
||||
* [Web Installation](frontend/installation.md)
|
||||
* [Styleguide](frontend/styleguide.md)
|
||||
* [Todo's](frontend/todos.md)
|
||||
* [Web Installation](web-frontend/installation.md)
|
||||
* [Styleguide](web-frontend/styleguide.md)
|
||||
* [Todo's](web-frontend/todos.md)
|
||||
|
||||
## Workflow
|
||||
|
||||
* [Testing Guide](integration-tests/testing/README.md)
|
||||
* [Integration Testing](integration-tests/testing/integration-testing.md)
|
||||
* [Component Testing](integration-tests/testing/component-testing.md)
|
||||
* [Unit Testing](integration-tests/testing/unit-testing.md)
|
||||
* [Pull-Requests](integration-tests/pull-requests.md)
|
||||
* [Deployment](integration-tests/deployment.md)
|
||||
* [Testing Guide](workflow/testing/README.md)
|
||||
* [Integration Testing](workflow/testing/integration-testing.md)
|
||||
* [Component Testing](workflow/testing/component-testing.md)
|
||||
* [Unit Testing](workflow/testing/unit-testing.md)
|
||||
* [Pull-Requests](workflow/pull-requests.md)
|
||||
* [Deployment](workflow/deployment.md)
|
||||
|
||||
## Recources
|
||||
|
||||
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
description: Our API Layer
|
||||
---
|
||||
|
||||
# GraphQL with Apollo
|
||||
|
||||
GraphQL is a data query language which provides an alternative to REST and ad-hoc web service architectures. It allows clients to define the structure of the data required, and exactly the same structure of the data is returned from the server.
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
description: No Database? No problem!
|
||||
---
|
||||
|
||||
# Mocking
|
||||
|
||||
### Mocking API Results
|
||||
@ -1,6 +1,6 @@
|
||||
# Seeding
|
||||
|
||||
### Seeding The Database
|
||||
## Seeding The Database
|
||||
|
||||
Optionally you can seed the GraphQL service by executing mutations that will write sample data to the database:
|
||||
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
description: Lets try to install the Human Connection - Nitro Backend
|
||||
---
|
||||
|
||||
# Backend Installation
|
||||
|
||||
{% hint style="warning" %}
|
||||
@ -1,10 +1,3 @@
|
||||
---
|
||||
description: >-
|
||||
GraphQL Middleware lets you run arbitrary code before or after a resolver is
|
||||
invoked. It improves your code structure by enabling code reuse and a clear
|
||||
separation of concerns.
|
||||
---
|
||||
|
||||
# Middleware
|
||||
|
||||
|
||||
@ -1,5 +1,11 @@
|
||||
---
|
||||
description: Want to help on the Backend / API part?
|
||||
---
|
||||
|
||||
# Todo's
|
||||
|
||||
Github Issues: [https://github.com/Human-Connection/Nitro-Backend/issues](https://github.com/Human-Connection/Nitro-Backend/issues)
|
||||
|
||||
* [x] add jwt authentication \(in progress\)
|
||||
* [ ] get directives working correctly \(@toLower, @auth, @role, etc.\)
|
||||
* [ ] check if search is working
|
||||
@ -1,3 +0,0 @@
|
||||
# Todo's
|
||||
|
||||
* [ ]
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
description: 'The styleguide is not just a guide, its also our Design System.'
|
||||
---
|
||||
|
||||
# Styleguide
|
||||
|
||||
For this Projoject we decided to use [Jörg Bayreuther's](https://github.com/visualjerk) _\(visualjerk\)_ fantastic Design System called [CION](https://cion.visualjerk.de/). _\(see a_ [_demo_](https://styleguide.cion.visualjerk.de/)_\)_
|
||||
8
web-frontend/todos.md
Normal file
8
web-frontend/todos.md
Normal file
@ -0,0 +1,8 @@
|
||||
---
|
||||
description: 'Want to help? Here you finde the recources for the Web part:'
|
||||
---
|
||||
|
||||
# Todo's
|
||||
|
||||
Github Issues: [https://github.com/Human-Connection/Nitro-Web/issues](https://github.com/Human-Connection/Nitro-Web/issues)
|
||||
|
||||
@ -1,2 +1,4 @@
|
||||
# Deployment
|
||||
|
||||
|
||||
|
||||
@ -1,2 +1,4 @@
|
||||
# Pull-Requests
|
||||
|
||||
|
||||
|
||||
@ -1,7 +1,3 @@
|
||||
---
|
||||
description: Explaniation of the main three testing approaches.
|
||||
---
|
||||
|
||||
# Testing Guide
|
||||
|
||||
## [Integration Testing](integration-testing.md)
|
||||
@ -1,2 +1,4 @@
|
||||
# Component Testing
|
||||
|
||||
|
||||
|
||||
@ -1,9 +1,3 @@
|
||||
---
|
||||
description: >-
|
||||
Here you can find information on how we are testing the whole application
|
||||
automaicaly.
|
||||
---
|
||||
|
||||
# Integration Testing
|
||||
|
||||
## Install Cypress
|
||||
@ -1,2 +1,4 @@
|
||||
# Unit Testing
|
||||
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user