1.0.11 • Published 4 years ago
with-batteries v1.0.11
with-batteries
A CLI tool for generating React and Next apps with all the neccessary batteries (packages) included. It's also come with Typescript support out of the box. It's a great way to start your next project.
The package contains 4 directories like so:
Next with TypeScript(batteries included)Next with JavaScript(batteries included)React with TypeScript(batteries included)created using ViteReact with JavaScript(batteries included)created using Vite
Installation
- In your terminal, run:
npx with-batteries name-of-your-project- Then choose from one of the templates.
- Finally choose your preferred variant and run:
cd name-of-your-project
npm install or yarn
npm run dev or yarn run devIncluded Batteries:
For React
AxiosReact RouterReact QueryTailwind(with a predefined config file)Eslint Config React App(to give you linting similar to create-react-app)- Configured with
ScrollToToputility, more info can be found inApp.jsx/tsxfile insrcdirectory.
For more info regarding the various dependencies please refer to the
package.jsonFor Next
AxiosReact QueryTailwind(with a predefined config file)eslint-plugin-reactTypes required for the TypeScript variantThe.eslintrcfile has also been provided with a starter template. For more info regarding the various dependencies please refer to thepackage.json
NOTE:
The React templates are not provided with a README file. You can add one after scafolding the project.
TODO
- Add Storybook templates
- Add Testing to the existing as well as upcoming templates.