The first version of Marvin was released in 2016. After more than four years, we have taken the decision to deprecate it.
The React tooling landscape has changed significantly - for the better - since Marvin was first introduced. New platforms, libraries, developer utilities - this ecosystem continues to relentlessly evolve. Maintaining a single boilerplate to capture all these possibilities has become an unproductive endeavor.
This repository will remain available for posterity, but moving forward no new features will be added or maintenance taking place. You might want to check the Recommended Toolchains section on the official React website.
A big thank you to everyone who used, supported, and contributed to Marvin over the years.
v2.0.0
Documentation and some features are still WIP, but Marvin is ready for production apps. Please provide us feedback to make Marvin even better.
If you are looking for the old version, check v1.1 branch.
React app boilerplate based on React Create App.
Marvin is internal project by Work & Co. We love React and open source. Marvin was born to be a starting point for our React projects.
Since first released, Marvin changed a lot and now it is a (thin) opinionated wrapper around official Create React App. It adds things like typescript support, hot module reload, router and others.
Name comes from a fictional character Marvin, android from the The Hitchhiker's Guide to the Galaxy book as a homage to it's author Douglas Adams.
- React (obviously)
- Typescript
- Hot Module Reload
- React router
- Testing using Jest
- Redux
- redux-saga
- Redux DevTools (you need to have browser extension installed)
- CSS with autoprefixing (CSS modules and SASS are optional)
- Importing SVG files as React components
- Optional page snapshoting using react-snap
- Optional git hooks
More features will be added in the future.
Marvin was tested on node version 12.x
Clone this repo and install dependencies:
npm install
Now run simple setup script:
node setup.js
It will take you through the short setup process. For now there are only a couple options to choose from:
- SCSS support
- Pre-Rendering Static HTML Files using react-snap
- Git hooks (run linter on commit and run tests before push)
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.