Delete/move documentation markdown files
36
cypress/integration-testing.md
Normal file
@ -0,0 +1,36 @@
|
||||
# Integration Testing
|
||||
|
||||
### Run Tests
|
||||
|
||||
To run the tests, make sure you are at the root level of the project, in your console and run the following command:
|
||||
|
||||
```bash
|
||||
$ yarn cypress:setup
|
||||
```
|
||||
After verifying that there are no errors with the servers starting, open another tab in your terminal and run the following command:
|
||||
|
||||
```bash
|
||||
$ yarn cypress:run
|
||||
```
|
||||
|
||||

|
||||
|
||||
After the test runs, you will also get some video footage of the test run which you can then analyse in more detail.
|
||||
|
||||
### Open Interactive Test Console
|
||||
|
||||
If you are like me, you might want to see some visual output. The interactive cypress environment also helps at debugging your tests, you can even time travel between individual steps and see the exact state of the app.
|
||||
|
||||
To use this feature, you will still run the `yarn cypress:setup` above, but instead of `yarn cypress:run` open another tab in your terminal and run the following command:
|
||||
|
||||
```bash
|
||||
$ yarn cypress:open
|
||||
```
|
||||
|
||||

|
||||
|
||||
### Write some Tests
|
||||
|
||||
Check out the Cypress documentation for further information on how to write tests:
|
||||
[https://docs.cypress.io/guides/getting-started/writing-your-first-test.html\#Write-a-simple-test](https://docs.cypress.io/guides/getting-started/writing-your-first-test.html#Write-a-simple-test)
|
||||
|
||||
|
Before Width: | Height: | Size: 720 KiB |
|
Before Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 74 KiB |
|
Before Width: | Height: | Size: 160 KiB |
|
Before Width: | Height: | Size: 107 KiB |
|
Before Width: | Height: | Size: 433 KiB |
|
Before Width: | Height: | Size: 379 KiB |
@ -1,77 +0,0 @@
|
||||
# Backend Installation
|
||||
|
||||
The Backend repository can be found on GitHub. [https://github.com/Human-Connection/Nitro-Backend](https://github.com/Human-Connection/Nitro-Backend)
|
||||
|
||||
{% hint style="info" %}
|
||||
TODO: Create documentation section for How to Start and Beginners.
|
||||
{% endhint %}
|
||||
|
||||
Here are some general informations about our [GitHub Standard Fork & Pull Request Workflow](https://gist.github.com/Chaser324/ce0505fbed06b947d962).
|
||||
|
||||
### Fork the Repository
|
||||
|
||||
Click on the fork button.
|
||||
|
||||

|
||||
|
||||
### Clone your new Repository
|
||||
|
||||
Set the current working folder to the path in which the backend repository should be cloned \(copied\).
|
||||
|
||||
```bash
|
||||
$ cd PATH-FOR-NITRO-BACKEND
|
||||
```
|
||||
|
||||
For cloning your new repository to your local machine modify the following command to add your GitHub user name.
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="HTTPS" %}
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/YOUR-GITHUB-USERNAME/Nitro-Backend.git
|
||||
```
|
||||
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="SSH" %}
|
||||
|
||||
```bash
|
||||
$ git clone git@github.com:YOUR-GITHUB-USERNAME/Nitro-Backend.git
|
||||
```
|
||||
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
Change into the new folder.
|
||||
|
||||
```bash
|
||||
$ cd Nitro-Backend
|
||||
```
|
||||
|
||||
Add the original Human Connection repository as `upstream`. This prepares you to synchronize your local clone with a simple pull command in the future.
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="HTTPS" %}
|
||||
|
||||
```bash
|
||||
$ git remote add upstream https://github.com/Human-Connection/Nitro-Backend.git
|
||||
```
|
||||
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="SSH" %}
|
||||
|
||||
```bash
|
||||
$ git remote add upstream git@github.com:Human-Connection/Nitro-Backend.git
|
||||
```
|
||||
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
### Copy Environment Variables
|
||||
|
||||
```bash
|
||||
$ cp .env.template .env
|
||||
```
|
||||
|
||||
Configure the file `.env` according to your needs and your local setup.
|
||||
@ -1,82 +0,0 @@
|
||||
# Docker Installation
|
||||
|
||||
Docker is a software development container tool that combines software and its dependencies into one standardized unit that contains everything needed to run it. This helps us to avoid problems with dependencies and makes installation easier.
|
||||
|
||||
## General Installation of Docker
|
||||
|
||||
There are [sevaral ways to install Docker CE](https://docs.docker.com/install/) on your computer or server.
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Docker Desktop macOS" %}
|
||||
|
||||
Follow these instructions to [install Docker Desktop on macOS](https://docs.docker.com/docker-for-mac/install/).
|
||||
|
||||
{% endtab %}
|
||||
{% tab title="Docker Desktop Windows" %}
|
||||
|
||||
Follow these instructions to [install Docker Desktop on Windows](https://docs.docker.com/docker-for-windows/install/).
|
||||
|
||||
{% endtab %}
|
||||
{% tab title="Docker CE" %}
|
||||
|
||||
Follow these instructions to [install Docker CE](https://docs.docker.com/install/).
|
||||
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
Check the correct Docker installation by checking the version before proceeding. E.g. we have the following versions:
|
||||
|
||||
```bash
|
||||
$ docker --version
|
||||
Docker version 18.09.2
|
||||
$ docker-compose --version
|
||||
docker-compose version 1.23.2
|
||||
```
|
||||
|
||||
## Install Nitro-BackEnd with Docker
|
||||
|
||||
Run the following command to install Nitro-Backend 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 Neo4j in Docker
|
||||
|
||||
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 %}
|
||||
|
||||
### Development with Kubernetes
|
||||
|
||||
For further informations see also our [Kubernetes documentation](kubernetes.md).
|
||||
@ -1,5 +0,0 @@
|
||||
# Kubernetes
|
||||
|
||||
Currently you can find some documentation here:
|
||||
[https://github.com/Human-Connection/Nitro-Deployment](https://github.com/Human-Connection/Nitro-Deployment)
|
||||
|
||||
@ -1,188 +0,0 @@
|
||||
# Local Installation
|
||||
|
||||
Make sure you have a recent LTS (long term support) version of [node](https://nodejs.org/en/download/) - we currently use 10.15.1
|
||||
|
||||
```bash
|
||||
$ node -v
|
||||
v10.15.1
|
||||
```
|
||||
|
||||
Make sure that you have a recent version of [yarn](https://yarnpkg.com/en/) or [npm](https://www.npmjs.com) installed before you proceed. E.g. we have the following versions:
|
||||
|
||||
```bash
|
||||
$ yarn --version
|
||||
1.12.3
|
||||
$ npm --version
|
||||
6.4.1
|
||||
```
|
||||
|
||||
If the `yarn` or `npm` command is unknown you may use the [docker installation](./#installation-and-usage-with-docker) \(see above\) or contact the developer team at [Discord](https://discord.gg/6ub73U3) if you have any questions:
|
||||
|
||||
## Install Dependencies
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Yarn" %}
|
||||
```bash
|
||||
$ yarn install
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="NPM" %}
|
||||
```bash
|
||||
$ npm install
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
## Start the Server
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Yarn" %}
|
||||
|
||||
### Development
|
||||
|
||||
```bash
|
||||
$ yarn run dev
|
||||
```
|
||||
|
||||
### Production
|
||||
|
||||
```bash
|
||||
# you will need to build the app first
|
||||
$ yarn run build
|
||||
# run after build (dist folder must exist)
|
||||
$ yarn run start
|
||||
```
|
||||
|
||||
{% endtab %}
|
||||
{% tab title="NPM" %}
|
||||
|
||||
### Development
|
||||
|
||||
```bash
|
||||
$ npm run dev
|
||||
```
|
||||
|
||||
### Production
|
||||
|
||||
```bash
|
||||
# you will need to build the app first
|
||||
$ npm run build
|
||||
# run after build (dist folder must exist)
|
||||
$ npm run start
|
||||
```
|
||||
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
This will start the GraphQL service \(by default on [http://localhost:4000](http://localhost:4000)\) where you can issue GraphQL requests or access GraphQL Playground in the browser.
|
||||
|
||||
{% hint style="warning" %}
|
||||
But before you can issue GraphQL requests or access GraphQL Playground you have to install, start and seed your Neo4j database. See following step …
|
||||
{% endhint %}
|
||||
|
||||
## Neo4j Installation and Configuration
|
||||
|
||||
### Configure Environment
|
||||
|
||||
Set your Neo4j connection string and credentials in `.env`. For example:
|
||||
|
||||
{% code-tabs %}
|
||||
{% code-tabs-item title=".env" %}
|
||||
|
||||
```yaml
|
||||
NEO4J_URI=bolt://localhost:7687
|
||||
NEO4J_USER=neo4j
|
||||
NEO4J_PASSWORD=letmein
|
||||
```
|
||||
|
||||
{% endcode-tabs-item %}
|
||||
{% endcode-tabs %}
|
||||
|
||||
### Neo4j Installation
|
||||
|
||||
{% hint style="warning" %}
|
||||
You **need to install APOC** as a plugin for the graph you create in neo4j!
|
||||
{% endhint %}
|
||||
|
||||
Note that grand-stack-starter does not currently bundle a distribution of Neo4j. Now there are a lot alternatives how to install Neo4J.
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Neo4j Desktop" %}
|
||||
|
||||
You can [download Neo4j Desktop](https://neo4j.com/download-center/) run locally for development. Choose tab **Neo4j Desktop**.
|
||||
|
||||

|
||||
|
||||
After the download is done install the Neo4j Desktop application and open it. E.g. we have the following version:
|
||||
|
||||
```text
|
||||
Neo4j Desktop 1.1.13
|
||||
```
|
||||
|
||||
Click on the empty project **My Project** to choose it.
|
||||
|
||||
Click in the **Add Graph** area and after two buttons appear in it click on **Create a Local Graph**.
|
||||
|
||||
Optionally, set the name of the new Graph for clarity to **Human Connection DB**. Set the password to **letmein** which is our default password of our `.env.template`. You can choose another password and later change your connection settings, too. Then click on **Create** and the database will be generated.
|
||||
|
||||
After generation of the database was successful, please click in the **Add Plugin** area. Then click the **Install** button of the **APOC** area. Now an additional **Install** button appears and you click on it again. If the **APOC-Plugin** is installed by now close the **Plugins** window.
|
||||
|
||||
In the **Human Connection DB** area is a **Manage** button. By clicking it the area switches into a manage area with a lot of information and setting possibilities.
|
||||
|
||||
Start the Graph database by clicking the **Play-Symbol** button. In the **Logs** tab you'll find the status of the start up.
|
||||
|
||||
If you have a look in the **Details** tab you find the connection info. The bolt port should be `7687` as we set it for our [environment configuration](docker-backend.md#configure-environment) above.
|
||||
|
||||
{% endtab %}
|
||||
{% tab title="Neo4j Non-Desktop Alternatives" %}
|
||||
|
||||
You can spin up a [hosted Neo4j Sandbox instance](https://neo4j.com/download-center/), 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 credentials in `.env`.
|
||||
|
||||
#### Install APOC plugin on Debian-based systems
|
||||
|
||||
Install `neo4j` from the Debian Repository, then [download the APOC plugin](https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/3.4.0.3/apoc-3.4.0.3-all.jar) to the `/var/lib/neo4j/plugins` directory, e.g. with:
|
||||
|
||||
```bash
|
||||
$ wget https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/3.5.0.1/apoc-3.5.0.1-all.jar -P /var/lib/neo4j/plugins
|
||||
```
|
||||
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
### Database Informations and Commands via Browser
|
||||
|
||||
Information about your Neo4j database can be obtained in your browser via [http://localhost:7474/browser/](http://localhost:7474/browser/).
|
||||
You can even send commands to Neo4j here. For example, for creating indices, as described in the next step.
|
||||
|
||||
### Create Indices in Neo4j
|
||||
|
||||
{% hint style="info" %}
|
||||
TODO: Is there a terminal command to create indices in Neo4j, because that would be a more general solution …
|
||||
{% endhint %}
|
||||
|
||||
To create the required indexes in Neo4j, you must send the following command to the database using the [browser command line](#database-informations-and-commands-via-browser), see above.
|
||||
|
||||
```sh
|
||||
$ CALL db.index.fulltext.createNodeIndex("full_text_search",["Post"],["title", "content"]);
|
||||
```
|
||||
|
||||
### Seeding Database with Data
|
||||
|
||||
Now we have to seed our database with default data, so that GraphQL requests or playing with our GraphQL Playground returns anything else than an empty response.
|
||||
|
||||
To fill the database with some seed data, run the following command in your terminal:
|
||||
|
||||
```bash
|
||||
$ yarn run db:seed
|
||||
```
|
||||
|
||||
To wipe out the database:
|
||||
|
||||
```bash
|
||||
$ yarn run db:reset
|
||||
```
|
||||
|
||||
Now your backend is ready for requests. You can click on the **Open Browser** button in Neo4j Desktop to check if the seeding was successful or open [http://localhost:7474/](http://localhost:7474/) in your browser.
|
||||
|
||||
Click the **Data-Symbol** at the left upper corner and then click on the **Node Label** + **User** to see a graph of the user relations, as an example.
|
||||
@ -1,19 +0,0 @@
|
||||
# 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
|
||||
* [x] check if sorting is working
|
||||
|
||||
> There is currenty an issue with neasted data which will be fixed in the next weeks
|
||||
|
||||
* [x] check if pagination is working
|
||||
* [ ] check if upload is working
|
||||
|
||||
> is possible with graphql-yoga
|
||||
|
||||
* [x] evaluate middleware
|
||||
* [ ] ignore Posts and Comments by blacklisted Users \(in progress\)
|
||||
|
||||
@ -1,67 +0,0 @@
|
||||
# Web Installation
|
||||
|
||||
{% hint style="warning" %}
|
||||
This documentation should be split into a **local** and a **docker** installation variant. Also maybe there should be a main docker installation guide for the whole system at once!?
|
||||
{% endhint %}
|
||||
|
||||
## Clone Repository
|
||||
|
||||
The Frontend Repository can be found on github.
|
||||
[https://github.com/Human-Connection/Nitro-Web](https://github.com/Human-Connection/Nitro-Web)
|
||||
|
||||
```bash
|
||||
git@github.com:Human-Connection/Nitro-Web.git
|
||||
```
|
||||
|
||||
## Install Dependencies
|
||||
|
||||
{% hint style="info" %}
|
||||
Make sure you are running on LTS Node 10: `node --version`
|
||||
{% endhint %}
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Yarn" %}
|
||||
```bash
|
||||
yarn install
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="NPM" %}
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
## Development
|
||||
|
||||
To start developing you need to start the server with the dev command. This will give you "hot reload" which updates the browser content \(mostly\) without reloading the whole page.
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Yarn" %}
|
||||
```bash
|
||||
yarn dev
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="NPM" %}
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
This will start the UI under [http://localhost:3000](http://localhost:3000)
|
||||
|
||||
For development environments, we created three users with different profiles and privileges.
|
||||
|
||||
Login to the app with one the following credentials:
|
||||
|
||||
* email: user@example.org
|
||||
* email: moderator@example.org
|
||||
* email: admin@example.org
|
||||
|
||||
password: 1234 \(same for all profiles\)
|
||||
|
||||

|
||||
|
||||
@ -1,46 +0,0 @@
|
||||
# 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/)_\)_
|
||||
|
||||

|
||||
|
||||
### Developing with the Styleguide
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Yarn" %}
|
||||
```bash
|
||||
yarn styleguide
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="NPM" %}
|
||||
```bash
|
||||
npm run styleguide
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
### Build
|
||||
|
||||
if you changed design tokens or other styles inside the styleguide, run the refresh command to build the styleguide as a lib.
|
||||
|
||||
{% hint style="info" %}
|
||||
The Styleguide is build when installing the UI via Yarn or NPM, but when you have changes inside the styleguide, you will need to run following command so they will be repflected in the main UI
|
||||
|
||||
We want to improve this in the future while running `yarn dev`.
|
||||
{% endhint %}
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="Yarn" %}
|
||||
```bash
|
||||
yarn styleguide:build
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="NPM" %}
|
||||
```bash
|
||||
npm run styleguide:build
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
---
|
||||
description: 'Want to help? Here you find 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,4 +0,0 @@
|
||||
# Component Testing
|
||||
|
||||
|
||||
|
||||
@ -1,33 +0,0 @@
|
||||
# Integration Testing
|
||||
|
||||
## Install Cypress
|
||||
|
||||
Before we start, first install [Cypress](https://www.cypress.io/) on your dev machine.
|
||||
|
||||
```bash
|
||||
$ yarn global add cypress
|
||||
```
|
||||
|
||||
### Run Tests
|
||||
|
||||
To run the tests, open the directory of our Nitro Frontend in your console and run following command:
|
||||
|
||||
```bash
|
||||
$ cypress run
|
||||
```
|
||||
|
||||

|
||||
|
||||
After the test run, you will get also some video footage of the test run which you can then analyse in more detail.
|
||||
|
||||
### Open Interactive Test Console
|
||||
|
||||
If you are like me, you might want to see some visual output. The interactive cypress environment also helps at debugging your tests, you can even time travel between individual steps and see the exact state of the app.
|
||||
|
||||

|
||||
|
||||
### Write some Tests
|
||||
|
||||
Go the the Cypress documentation for further information on how to write tests:
|
||||
[https://docs.cypress.io/guides/getting-started/writing-your-first-test.html\#Write-a-simple-test](https://docs.cypress.io/guides/getting-started/writing-your-first-test.html#Write-a-simple-test)
|
||||
|
||||
@ -1,20 +1,20 @@
|
||||
# Testing Guide
|
||||
|
||||
## [Integration Testing](integration-testing.md)
|
||||
## [Integration Testing](./cypress/integration-testing.md)
|
||||
|
||||
To test all the pieces together, from the user perspective, we use integration tests. They also show if the the backend and the frontend are working as expected in conjunction and also if the browser likes our app.
|
||||
|
||||
[more...](integration-testing.md)
|
||||
[more...](./cypress/integration-testing.md)
|
||||
|
||||
## [Component Testing](component-testing.md)
|
||||
## [Component Testing](./webapp/component-testing.md)
|
||||
|
||||
Individual Vue Components should also be documented and tested properly. This guarantees that they are reusable and the api gets more solid in the process.
|
||||
|
||||
[more...](component-testing.md)
|
||||
[more...](./webapp/component-testing.md)
|
||||
|
||||
## [Unit Testing](unit-testing.md)
|
||||
## [Unit Testing](./backend/unit-testing.md)
|
||||
|
||||
Expecially the Backend relies on Unit Tests, as there are no Vue Components.
|
||||
|
||||
[more...](unit-testing.md)
|
||||
[more...](./backend/unit-testing.md)
|
||||
|
||||
7
webapp/component-testing.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Component Testing
|
||||
|
||||
We are using `Jest` as our test runner, along with `vue-test-utils`.
|
||||
|
||||
Head over and check out the documentation on [Jest](https://jestjs.io/docs/en/getting-started.html)
|
||||
|
||||
Also, check out [vue-test-utils](https://vue-test-utils.vuejs.org/)
|
||||
11
webapp/styleguide.md
Normal file
@ -0,0 +1,11 @@
|
||||
# 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/)_\)_
|
||||
|
||||

|
||||
|
||||
### Checkout the Styleguide
|
||||
|
||||
It's now an npm package. Want to help with it's development or maintenance?
|
||||
|
||||
[Head over to the repo](https://github.com/Human-Connection/Nitro-Styleguide)
|
||||