神刀安全网

ReactJS: Setting up the Environment

This post helps setting up the development environment for React on VS Code using Browserify and Gulp

I have been playing around with React for the past few days and liking the one way binding and immutability concept that it puts forward. The component-based approach and having all related code in a single place is really interesting. Need to explore more and see how it really turns out building UI’s with React.

The openness of the Web makes it really difficult to get started with any development platform on it and is the same with React. There are a lot of options for getting things done and can get overwhelming when newly starting out . This post explains ‘one way’ to set up the development environment when developing an application using the React JavaScript framework. I am using VS Code for some time now and wanted to use the same for React development. Except for setting up VS Code, everything else would still make sense to you if you are using a different editor.

Package Manager for External Dependencies

One of the first things we need when starting with a fresh project on React, is the React library itself. I use Node Package Manager(npm) for managing all my code and development dependencies. Use the below commands to set up the npm configuration ( package.json ) and install the latest version of React library.

npm init npm i --save react npm i --save react-dom 

When installing npm packages use –save if it needs to be deployed with the application and use –save-dev for a package added to support development.

Setting up VS Code

JavaScript development experience is better when you have jsconfig.json file in your project root. VSCode recommends adding this file through a small light bulb notification on the right side of the status bar (as shown below). With this configuration file, VSCode treats all the js files under the same project context.

ReactJS: Setting up the Environment

Intellisense for libraries is available through type definition files, usually available in the DefinitelyTyped repository . With npm, you can manage these definition files using the TypeScript Definition Manager (typings) package. To get started install the typings package and support for node packages. Now you can use typings to manage all the typescript definitions and use it for getting IntelliSense support. Once you have the correct type definitions installed for the packages you use, VSCode will show IntelliSense as shown below.

npm i --save-dev typings typings install --ambient node typings install --save-dev gulp 

ReactJS: Setting up the Environment

Hello World from React

Now that we have enough to get us started let’s write our first react component, which displays a message passed into it.

'use strict';  import React from 'react';  var HelloWorld = React.createClass({    render: function(){        return (            <div>{this.props.message}</div>        );    } });  export default HelloWorld 

Let’s save the above into components/helloworld.js . To use this component in the application, it needs to be rendered into the HTML page. So let’s add a main entry point for the application as below and save it into main.js . Notice how the component is referred in here and rendered into the HTML div element app .

"use strict";  import React from 'react'; import ReactDOM from 'react-dom'; import HelloWorld from './components/helloworld';  ReactDOM.render(     <HelloWorld message ="Hello World From React" />,     document.getElementById('app') ); 

For completeness below is how the Index.html looks

<html> <head> </head> <body>      <div id="app"></div>     <script type="text/javascript" src="main.js"></script> </body> </html> 

Using Browserify for Bundling

Now that we have all the code needed for rendering the component, let’s bundle up all the different JavaScript files together so that we can deploy it as a single file. Since we are using JSX and ES6 features, which not all browsers support, we need to transform it. Babel is a JavaScript compiler to get this done and it also has preset specific to react and es2015 . Browserify bundles all the JavaScript modules and also enables specifying transforms using the –transform (-t) switch, to pass in babel along with the presets required.

browserify -t [babelify --presets [react es2015] ] src/main.js -o dest/main.js -d 

If you now manually copy over the HTML file into the dest folder and open it from there you should be seeing the ‘ Hello World from React ’ message.

Automating Build and More

I definitely did not want to keep running the above command and copy the HTML(/CSS) files, every time I make a change, to see the output – so automating it was very much required. What I would essentially like to have is every time I make a change on any of the files in the project, the build to trigger and output the updated application into the dest folder and automatically refreshing the browser so that I can see the changes (near) real-time. I chose to use Gulp as this is popular and I have had some experience using it before .

gulpfile.js

To organize all the different path’s used in the gulp build file, I have an object, path holding all the properties together, that’s used in the gulp tasks . The different tasks that I have defined are to build ( which copyHtmlFiles and builds and transforms js files), lint , watch ‘es the source folder for changes and triggers the required build, connect ’s a server to host the application and automatically reload ’s the browser whenever code is changed.

var appConfig = {     localBaseUrl: 'http://localhost',     port: 8090,     paths : path }  gulp.task('copyHtmlFiles', function () {     gulp.src(path.HTML)         .pipe(gulp.dest(path.DEST))         .pipe(connect.reload());  });  gulp.task('js', function () {     browserify(path.MAINJS, { debug: true })         .transform(babelify, { presets: ['react', 'es2015'] })         .bundle()         .on('error', console.error.bind(console))         .pipe(source('main.js'))         .pipe(gulp.dest(path.DEST))         .pipe(connect.reload());;  });  gulp.task('build', ['copyHtmlFiles', 'js']);  gulp.task('lint', function () {     gulp.src(path.JS)         .pipe(lint({ config: 'eslint.config.json' }))         .pipe(lint.format()) });  gulp.task('watch', function () {     gulp.watch(path.HTML, ['copyHtmlFiles']);     gulp.watch(path.JS, ['js']); });  gulp.task('connect', function () {     connect.server({         root: 'dist',         livereload: true,         port: appConfig.port     }); });  gulp.task('reload', function () {     gulp.src('dist/**/*').pipe(connect.reload()); });  gulp.task('open', function(){         gulp.src(path.DEST + 'Index.html')         .pipe(open({uri : appConfig.localBaseUrl + ':'+appConfig.port + '/'})); });  gulp.task('default', ['build', 'connect', 'lint', 'open', 'watch']); 

With the default gulp task running, either using VSCode Task Runner or the command line , any edits that I make to the code gets build and pushed to the output directory and the browser refreshes to show the latest changes.

ReactJS: Setting up the Environment

If you find any package details missing see the package.json file.

You can find the hello world project template here . The repository size is a bit high as I have included the npm packages ( node_modules ) in the repository, which you would have anyways downloaded when doing a ‘ npm install ’.

Hope this helps you to get started with React!

转载本站任何文章请注明:转载至神刀安全网,谢谢神刀安全网 » ReactJS: Setting up the Environment

分享到:更多 ()

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址