https://github.com/regexpressyourself/gitflow
:octocat: Interactive git cheat sheet
https://github.com/regexpressyourself/gitflow
css html javascript react webpack
Last synced: 5 months ago
JSON representation
:octocat: Interactive git cheat sheet
- Host: GitHub
- URL: https://github.com/regexpressyourself/gitflow
- Owner: regexpressyourself
- License: mit
- Created: 2017-01-03T22:44:53.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T22:16:01.000Z (over 3 years ago)
- Last Synced: 2024-04-14T13:12:53.551Z (about 2 years ago)
- Topics: css, html, javascript, react, webpack
- Language: JavaScript
- Homepage: https://gitflow.smessina.com/#/
- Size: 9.33 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Git Flow
Learn to use git through a dynamic, interactive flowchart.
[See it live here!](https://gitflow.smessina.com/)
## Table of Contents
1. [Getting Started](#getting-started)
2. [Deployment](#deployment)
2. [Built With](#built-with)
3. [Contributing](#contributing)
3. [Authors](#authors)
3. [License](#license)
## Introduction
Git Flow walks you through a typical merge workflow with git. Git Flow presents each step needed to use git as an interactive flowchart. As the tutorial progresses, users choose paths that are relevant to their needs, making sure that unnesescary information gets filtered out.
## Getting Started
Git Flow uses Webpack and NPM to build and transpile all React code into regular HTML, CSS, and Javascript.
### Prerequisites
Make sure you have NodeJS and NPM installed. [You can download Node here](https://nodejs.org/en/download/). This will install NPM as well.
You are welcome to use [Yarn](https://yarnpkg.com/en/) instead of NPM if you prefer.
### Installing
First, clone the project to a local directory.
```
git clone https://github.com/regexpressyourself/gitflow.git && cd gitflow
```
Next, install the dependencies using NPM or Yarn.
#### Using NPM
```
npm install
```
#### Using Yarn
```
yarn install
```
**[Back to top](#table-of-contents)**
## Deployment
### Development Environment
To run Git Flow in development mode, you will need to run the `start` script declared in `package.json`.
#### Using NPM
```
npm run start
```
#### Using Yarn
```
yarn run start
```
That's it! Your development server is running at [http://localhost:8080](http://localhost:8080)
Webpack is configured with hot reloading, so any changes saved to source files will be immediately reflected in the browser.
### Production Build
To build a production version of the app, with all React code loaded into a bundled, minified Javascript file, you need to run the `production` script declared in package.json.
#### Using NPM
```
npm run production
```
#### Using Yarn
```
yarn run production
```
This will leave you with an `index.html` and an `index_bundle.js` file in the project root. Hosting these files from the same location will serve the production build of Git Flow.
**[Back to top](#table-of-contents)**
## Built With
* [React](https://facebook.github.io/react/) - The web framework that powers the site
* [Webpack](https://webpack.github.io/) - A module builder automate development and production build processes
* [React Router v. 3](https://reacttraining.com/react-router/) - Sits on top of React to enable route-based views without a backend server
* [Babel](https://babeljs.io/) - Transpiler to convert raw React code into browser-ready HTML and Javascript
**[Back to top](#table-of-contents)**
## Contributing
I'm always happy to receive pull requests, questions/issues regarding code, and feature requests on all my projects. Please feel free to open an issue or submit a pull request.
**[Back to top](#table-of-contents)**
## Authors
* **[Sam Messina](https://www.github.com/regexpressyourself)** - *Sole Developer*
**[Back to top](#table-of-contents)**
## License
Git Flow is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
**[Back to top](#table-of-contents)**