# Funfunz Documentation

[![Discord][discord-badge]][discord]
[![Build Status][actions-badge]][actions]
[![codecov][codecov-badge]][codecov]
![node][node]
[![npm version][npm-badge]][npm]
[![PRs Welcome][prs-badge]][prs]
[![GitHub][license-badge]][license]

## Useful links

**Backend**
- [Source code](https://github.com/Funfunz/funfunz)
- [Demo app](https://funfunz.herokuapp.com/)

**Backoffice**
- [Source code](https://github.com/funfunz/backoffice)
- [Demo app](https://funfunz.github.io/backoffice/)

**Template application**
- [Source code](https://github.com/Funfunz/funfunz-template)

## Overview

Funfunz was created due the lack of a functional back-office and API generator in the NodeJS community.

The goal is to generate a complete CMS/back-office/data manager application

Follow the quickstart [here](usage/quickstart.md)

## Current features
- CRUD operations
- GraphQL schema generator
- [Entity filters](usage/filters.md)
- [Data connector system](usage/dataConnectors/main.md)
- [Configurable Hooks](usage/hooks.md)
- [Request lifecycle](usage/hooks.md)

**Supported data connectors**
- [SQL databases](usage/dataConnectors/sql.md)

**Configuration generator**
- MySQL and MongoDB parser and configurations generator
- Friendly name generator for entity names and fields

## CLI

* `funfunz` - Runs the Wizard to setup the settings and configuration files needed to connect with a data source.

[discord-badge]: https://img.shields.io/discord/774439225520554004?logo=discord
[discord]: https://discord.gg/HwZ7zMJKwg

[actions-badge]: https://github.com/funfunz/funfunz/workflows/Node.js%20CI/badge.svg
[actions]: https://github.com/Funfunz/funfunz/actions

[codecov-badge]: https://codecov.io/gh/Funfunz/funfunz/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/Funfunz/funfunz

[node]: https://img.shields.io/node/v/@funfunz/core

[npm-badge]: https://img.shields.io/npm/v/@funfunz/core?color=brightgreen
[npm]: https://www.npmjs.com/package/@funfunz/core

[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[prs]: http://makeapullrequest.com

[license-badge]: https://img.shields.io/github/license/JWebCoder/funfunz.svg
[license]: https://github.com/JWebCoder/funfunz/blob/master/LICENSE