universal-boiler
v1.1.7
Published
boilerplate done right
Downloads
16
Readme
Introduction
Creating the first setup for your project is daunting, much of the time, you'd either search for a
pre-made boilerplate on github, that is usually never a tailor fit for your needs(and mostly outdated)
or go about a journey to make it yourself.(for the hundred time)
Universal-Boilerplate has three main goals!
- Construct a boilerplate that's tailor made for your needs, with all the tooling and jazz.
- Make it super easy for community contributions to be added.
- Be un-opinionated, un-restricting as much as possible, unlike awesome projects like next.js, we don't manage stuff for you.
We merely create the boilerplate and from there on, you're on your own. (for better and worse).
Prerequisites
You should have Node v12.13 and above, and npx installed on your machine.
Usage
npx universal-boiler
What's Supported and Roadmap
- [x] ReactJs (through cra)
- [x] Typescript
- [x] Node App
- [x] ExpressJs
- [x] Common middlewares for express
- [ ] Dev-Tools (prettier, husky, eslint, dotenv, loggers)
- [ ] Modular readme
- [ ] Testing frameworks (jest, mocha)
- [ ] Database connector support
- [ ] Fastify
- [ ] Vue.js
- [ ] Contributor guide
- [ ] Better design the flow for recursive question flow
- [ ] Monorepo (using yarn workspaces)
- [ ] Plain JS project
- [ ] More in the future !
Contributing
First of all, You're awesome, yea you!
Second, this project was built with the contributors in mind, it should and will be very easy to expand
and add new packages and options.
The project will be open to contributions very soon, and a well written contribution guide would be written.
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Naor Zruk - @ZrNaor - [email protected]