Let Me React - A Simple ReactJS Boilerplate

by React

Let Me React

Write your React App easily with Let Me React! This is similar to create-react-app but LMR will comes with useful packages like react-router-dom,Axios, SweetAlert2 pre-configured so that you can dive into writing your code without having to worry about setting up the project.

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.4.1
v8.16.0

Installation

BEFORE YOU INSTALL: please read the prerequisites

$ npm install -g let-me-react

After installation, use can use the following command to initialize your project.

$ let-me-react myproject

Alternatively, you can use npx to directly use let-me-react without installing globally.

$ npx let-me-react myproject

Usage

After initializing your project, you can use the following scripts.

Serving the app

$ npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser. The page will hot reload as you make edits.

Running the tests

$ npm test

Launches the test runner in the interactive watch mode. See the section about running tests for more information.

Building a distribution version

$ npm run build

Builds the app for production and files are saved to the build folder. It bundles your files in production mode and optimizes the build for the best performance. The build is minified and the filenames include hashes.

Your app is ready to be deployed!

Pre-Configured Plugins

  • Bulma CSS : a free, open source framework that provides ready-to-use frontend components that you can easily combine to build responsive web interfaces.
  • Sweetalert 2: A beautiful, responsive, customizable, accessible (WAI-ARIA) replacement for JavaScript's popup boxes. Zero dependencies.
  • Axios: an HTTP client library that allows you to make requests to a given endpoint.
  • Notistack: a notification library which makes it extremely easy to display notifications on your web apps.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

GitHub

https://github.com/Suvink/let-me-react