Giter VIP home page Giter VIP logo

gotron-react-redux-typescript-boilerplate's Introduction

gotron-react-boilerplate

A minimalistic boilerplate for gotron and reactjs. Tested on Windows, macOS and Linux.

This project contains only bare minimum of tooling and dependencies to provide you with simple to understand and extensible base (but still, this is fully functional).

Quick start

Make sure you have Node.js installed, then type the following commands known to every Node developer...

git clone https://github.com/Marlon-Monroy/gotron-react-boilerplate.git
cd gotron-react-boilerplate/ui
npm install
npm start

if you are using yarn

git clone https://github.com/Marlon-Monroy/gotron-react-boilerplate.git
cd gotron-react-boilerplate/ui
yarn
yarn start

This will download all the dependencies needed for react to work.

Structure of the project

The application consists of...

ui - Where all the ui and react related files live).

The build process compiles the content of the src folder and puts it into the dist folder, so after the build has finished, your dist folder contains the full, runnable application.

I've used mod for go depencency manager but i figured you might want to use something different so ive added the go.mod and go.sum files to .gitignore feel free to make changes as needed.

Development

Starting the app

npm run dev

if you are using yarn

yarn run dev

The build pipeline

Build process uses Webpack. The entry-points is src/index.js. Webpack will follow all import statements starting from those files and compile code of the whole dependency tree into one .js file for each entry point.

Babel is also utilised.

Side note: Im using react 16.7.alpha2 so that i can use hook.

Updating react version

To do so edit ui/package.json:

"dependencies": {
  "react": "16.7"
}

Adding npm modules to your app

Remember to respect the split between dependencies and devDependencies in package.json file. Your distributable app will contain modules listed in dependencies after running the release script.

Making a release

To package your app:

cd gotron-react-boilerplate/ui
npm run build

Once the packaging process finished, the dist directory will contain your distributable file.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.