j0hannsenn/react-initializr

📂 A web-based boilerplate-free React Project generator.

📂 React Initializr

• ❓ What is React Initializr?
• ❗ Important
• 📚 Teach stack
• ⚒️ Building from source
• 📝 License
• 🧑‍🤝‍🧑 Contributing
• 💡 Inspiration

---

❓ What is React Initializr?

• React Initializr is a simple, easy-to-use, web-based, boilerplate-free project generator.

• Generate modern React templates without barely touching the terminal - just fill in some input fields, add your beloved dependencies, and generate your project!

• You can browse amongst every available npm package thanks to the NPM Registry API.

• If you prefer to use TypeScript you can totally do that too, just select the TypeScript option before generating the project. The site will add all the necessary dependencies and files, you don't have to do anything else.

• Share your project with others - if you're about to create a tutorial, a blog, a course, or something that requires sharing your "starting point" with others, just click on the "Copy Link" button. If anyone opens that link, they can download exactly the same project as you did. Therefore you can almost skip the "generating project" phase.
Example: https://0l1v3rr.github.io/react-initializr?name=my-project&version=1.0.0&description=This+is+my+cool+project&language=TypeScript&packages=axios%3Breact-icons%3Breact-router

---

❗ Important

• The site generates a ZIP file. Just unzip it, cd to the folder (cd my-project), and run the command npm i. If you've successfully done this, you're good to go.

• You can find the boilerplate-free templates here. The site uses these as a base to generate your next project! ;)
  Note: The template is a transformed create-react-app template.

---

📚 Teach stack

Shout-out to the creators for creating these tools:

• TypeScript
• React
• React-Icons
• Axios
• File-Saver
• JSZip
• Recoil
• Tailwind
• React GH Pages

---

⚒️ Building from source

This process should only take a few minutes:

0. If you don't have NodeJS, download and install it.
1. Clone the project:

   git clone https://github.com/0l1v3rr/react-initializr.git
   cd react-initializr

2. Install the required dependencies:

   npm i

3. Now, you can run the app:

   npm start

---

📝 License

This project is licensed under the MIT License.

---

🧑‍🤝‍🧑 Contributing

Every contribution is welcomed.
You can find a contributing guideline here.

---

💡 Inspiration

I was inspired by start.spring.io, check it out as well. :*