# dig-framework

> DigFramework ============

Latest version **0.2.1** (published 2018-07-11) · 0 weekly downloads

## Install

```sh
npm install dig-framework
pnpm add dig-framework
yarn add dig-framework
bun add dig-framework
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2018-07-11 |
| First published | 2018-07-05 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 48.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | forrestlyman |

## Links

- npm: https://www.npmjs.com/package/dig-framework
- Homepage: https://github.com/forrestLyman/dig-framework
- Issues: https://github.com/forrestLyman/dig-framework/issues
- npm.io page: https://npm.io/package/dig-framework

## Recent versions

- 0.2.1 (latest) — 2018-07-11
- 0.2.0 — 2018-07-05
- 0.1.9 — 2018-07-05
- 0.1.8 — 2018-07-05
- 0.1.7 — 2018-07-05
- 0.1.6 — 2018-07-05
- 0.1.5 — 2018-07-05
- 0.1.4 — 2018-07-05
- 0.1.3 — 2018-07-05
- 0.1.2 — 2018-07-05
- 0.1.1 — 2018-07-05
- 0.1.0 — 2018-07-05

## README

DigFramework
============

![DigFramework Screenshot](docs/assets/screen-shot.png)

__DigFramework is currently in RAD/MVP development!!!__

Core Concept
------------

DigFramework is an opinionated content management / publishing platform that is based on a React and Material UI client
and the Google Cloud Platform on the backend. 

The theory behind the application is that content management has evolved a great deal in the last years, and that content 
can come from anywhere these days. The role of a content management system has grown as well, and we find it easier to 
develop custom solutions based on a low level framework than modify out of the box solutions; you don't have to say no nearly as often.

Dig manages 3 points of interest in your application:

### [User Interface](docs/ui.md)

The system includes a core UI layout, a series of pre built views, and a library of common elements. These are 
all built on Material UI to ensure consistency. You can customize the look and feel of them through the theme configuration
which is an extended version of the core MUI theme variables.

### [State](docs/state.md)

Dig maintains application state within the UI scope and provides utilities accessing public context including
data, the user session, and the theme. It will additionally provide getters and setters for custom data. Behind the scenes
we are using core React Context and Higher Order Components.

### [Data](docs/data.md)

Dig is built on the Google Firestore document database. It provides a simple, standardized client to read
and write data to the core database as well as a wide range of other data sources including Facebook, Twitter, WordPress APIs+++  (soon).

Quick Start
------------

First create your React app. We like `create-react-app` but there are no dependencies on it:

`npx create-react-app quickstart`

The application is built around the concept of pages, so we always use routing:

`npm i react-router-dom`

Next install the DigFramework

`npm install dig-framework`

At this point you should be able to run your project (which will render the default create-react-app).

`npm run start`

Now you are ready to configure and build your app.

[Get Started](docs/get-started.md)

Contribute
----------

Feel free to play around, and if you find any bugs or have ideas for features and improvements please
let us know [here](https://github.com/forrestLyman/dig-framework/issues).

If you would like to get actively involved in Dig development you should start by reviewing our [project roadmap](docs/roadmap.md).

---
_Source: https://npm.io/package/dig-framework · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
