https://github.com/mathiaskandelborg/true-docs

Documentation for the TRUE Framework built on Next.js and Material-UI
https://github.com/mathiaskandelborg/true-docs

Last synced: 24 days ago
JSON representation

Documentation for the TRUE Framework built on Next.js and Material-UI

• Host: GitHub
• URL: https://github.com/mathiaskandelborg/true-docs
• Owner: MathiasKandelborg
• License: mit
• Created: 2020-11-02T14:57:02.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-27T01:46:07.000Z (almost 2 years ago)
• Last Synced: 2023-03-06T12:17:58.275Z (over 1 year ago)
• Language: TypeScript
• Homepage: true-docs-git-master.kandelborg.vercel.app
• Size: 1.21 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


# TRUE Framework

[![Maintainability](https://img.shields.io/codeclimate/maintainability/MathiasKandelborg/TRUE-framework?style=for-the-badge)](https://codeclimate.com/github/MathiasKandelborg/TRUE-framework/maintainability)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release)

**THIS IS A DRAFT** - Come contribute and share your thoughts (make this a link)

## TRUE Framework === The Really Unique & Exciting Framework

Built on the shoulders of giants. Made to Just Work™ and follow specifications

TRUE is an opinionated starter kit based on technologies that seek to be:

- Efficient

- Have incredible user _and_ developer experience

- Be feature-full (without all the bloat)

### Overview

- Overview

- Reasoning

- Who would use this

- Installation

## Reasoning

A good starter kit reduces time spent solving problems, and improves the concept --> idea process.

When you start a project, it can be daunting to get everything right.

If one wants to have contributors, linting, versioning and other things, it would have to be implemented 'from the bottom'.

It is rarely the case that a project would have requirements that differ so much from the 'default' most people (want to) set up;

that's why it's often sensible to begin from a foundation instead of creating - and thereby re-thinking - what's essentially being created every time a new project is made.

In order to _apply and test_ ideas instead of **building** them, one should start from a flexible place that isn't too restrictive, but still get a lot of utility going without further thought.

For a starter kit with a lot of default utility and pre-made boilerplate, it's almost impossible to keep opinions away. This framework is opinionated and has to be in order to stay flexible, sleek and ready for large amounts of contributions.

## Who would use this

Mathias (the creator) is going to use this for all his website/app based projects.

Anyone who wants an easy time coding websites using NextJS, Sanity(CMS), Material-UI, Framer-motion and be able to do whatever they want in React.

## License

Anyone can do anything they want; it's their responsibility, however.

See LICENSE for reference

This project is free (as in beer 🍻) and open-source. Always will be.