m-martinez / pixeloven

Framework for building React applications. Supports SSR, React 16 and webpack4

Home Page:http://www.pixeloven.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PixelOven Framework

This project is a mono-repo designed to contain several packages that in combination make up the PixelOven Framework. Below are instructions on how to contribute to this project as well as directions on how to integrate each individual package into existing projects.

CircleCI Coverage Status Dev Dependencies styled with prettier Donate

Table of Contents

Requirements

This project has the following requirements for development. Keep in mind that the versions provided are a recommendation while other versions may be compatible they are untested.

  • Node >= 8.0.0
  • Yarn >= 1.0.0

Integration

TBD Link to each package here.

For existing projects please review our integration guide for more details.

Contribution

TBD Link to template directory with instructions for creating new template.

This project was born from a small collective effort within GoFundMe with the purpose to abstract common configuration and infrastructure used in the creation of isomorphic React applications. However, for this project to be even more successful we need your help. Join us and start coding! ❤️

Please consider reviewing our contribution guide for more details.

Features

TBD Add feature summary plus below might be inaccurate

Git Hooks

There is already set a precommit hook for formatting your code with Prettier 💅

By default, there are two disabled git hooks. They're set up when you run the npm run semantic-release-prepare script. They make sure:

This makes more sense in combination with automatic releases.

Improvements

Below are just some of the up coming ideas for improvements.

Our Commitment

We are committed to providing a safe place for everyone. Please review our code of conduct guidelines to help us with our commitment. Thank you!

Planned v5

  1. Finish re-write of build
  2. Remove .env as a requirement
  3. Update generators to have more react 16.8 features

Planned v6

  1. Move generators to use gluegun
  2. Unify all logging - use something more standard than webpack-log
  3. Remove react-dev-utils
  4. Add help to CLI and documentation
  5. Reach 90-100% test coverage
  6. Expose storybook addons through library
  7. Update middleware and examples
  8. node-mocks-http replace with supertest

About

Framework for building React applications. Supports SSR, React 16 and webpack4

http://www.pixeloven.com/

License:MIT License


Languages

Language:TypeScript 94.7%Language:HTML 3.7%Language:Shell 1.6%