Decide on project features for MVP

AlexGaiser / fast-react

A CLI tool to quickly spin up a lightweight and fully customizable react project

MIT License

0 stars 0 forks source link

Decide on project features for MVP #3

Open AlexGaiser opened 3 years ago

AlexGaiser commented 3 years ago

We will use this issue for discussing the projects base features.

AlexGaiser commented 3 years ago

This project should be:

Lightweight (as few dependencies as possible)
Configurable (unlike CRA all configuration files should be easily accessible) Future versions should allow optional installation of dependencies and additional configuration through command line arguments
Simple (all boilerplate should be taken care of with a minimum of additional configuration) Main page should have an extremely basic layout to avoid the need to delete html and styling each time a new project is spun up
Opinionated (Things like folder structure should match our ideas of the ideal react project organization)
Available on NPM / NPX

Scott-Ian commented 3 years ago

I've been playing around with create-new-app, as it seems like a great project example. What is our exact end goal with this project? Cna adds api support, MongoDB if requested. Are we building an app that will create an empty React project with some extra support tools like cna? Are we including some react-component templates to speed up the creation of a new web-page?

If we are adding some component templates, can I advocate that we use SCSS and maybe self-plug, and include freePi for placeholder content? Maybe buff up some downloads on that project too...

I guess, more to the point, what exactly are we looking to do that will separate our project from other similar projects? Since we want to make it simple and lightweight, what are we willing to cut feature-wise that other implementations have?

AlexGaiser commented 3 years ago

MVP should include:

ability to name project
opinionated folder structure
default dependencies installed
user defined dependencies installed
functioning react app
start scripts (follow same convention as react-app)
Babel / Webpack configs exposed
hot loading of UI
Jest as default testing library (optional flag, minimal)
template flags (preconfigured options so user doesn't need many flags for common)
eslint and prettier (optional flag)

AlexGaiser commented 3 years ago

I have added the comments from this page to our wiki. They can be found at the following pages: