This script aims to automate the process of initializing a React App using the Wolox standards.
How to use
To run from server:
You don't need to clone this repository. Just follow these steps:
Run the installation script using the following command:
bash <(curl -s https://raw.githubusercontent.com/Wolox/react-bootstrap/development/run.sh)
--verbose: Display more information as the bootstrap is running
--local: Run a local version of the bootstrap
To setup a local version of the bootstrap, you may clone it and do the following:
cd ./react-bootstrap npm link
After that, every time you want to run it you may execute the run script: with the local flag
# Make sure you are in the parent folder of the bootstrap ./react-bootstrap/run.sh -l
You can choose between two creation types: Clean and Customized
Create a clean project using create-react-app as baseline with some small addition to its configuration.
Choose your preferred libraries for your project and create a new React project with standard components, default screens, api services and common utils functions.
- FormInput (input and textarea)
|eslint-config-wolox||Wolox eslint standard rules.|
|eslint-config-wolox-react||Wolox eslint React rules.|
|react-hot-loader||Allow live reloaded without loss of state.|
|postcss||Tool for transforming styles with JS plugins.|
|env-cmd||Node program for executing commands using an environment from an env file.|
|aws-deploy-script-fe||AWS script for deploying your frontend applications.|
|node-sass||Provides binding for Node.js to LibSass, the C version of the popular stylesheet preprocessor, Sass.|
|react-dom||Serves as the entry point to the DOM and server renderers for React.|
Additional to clean libraries are added
|apisauce||Talking to APIs doesn't have to be awkward anymore.|
|react-router-dom||DOM bindings for React Router.|
|react-router||Routing for React.|
|typescript||Brings you optional static type-checking along with the latest ECMAScript|
|babel-module-resolver||Custom module resolver plugin for Babel.|
This script will configure your system to install global npm packages without having to use sudo.
Yeoman not found during project generation
Sometimes when running the generator, you will get an error indicating that
yeoman is not installed and a prompt with a message like:
-bash: yo: command not found. This could be due to having more than one node version installed, or not having the right
PATH configured. Either way, here is how to fix this issue.
NOTE: This solution works only if you have installed node using nvm (node version manager). We are working on a different solution that does not require nvm.
Step 1: Check if you have the right version of node setted
It's a common issue having two or more versions of node. What you need to do is make sure that the version that is shown with the command
node --version is the same as the one in your nvm directory (
nvm list). If not, you can set it using the command
nvm use -version- (e.g.:
nvm use v13.8.0).
Step 2: Add node binaries folder route to PATH
~/.zshrc or the configuration script for your shell you need to add the following line at the end of the file:
export PATH=$NVM_DIR/versions/node/$(node --version)/bin:$PATH
Save the changes, close and re-open the console or run
source .bashrc to apply the changes of the file. Now run the generator again. It should work just fine.
This repository is maintained by everyone at Wolox.
wolox-react-bootstrap is available under the MIT license.
Copyright (c) 2020 Wolox Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.