Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
jvalen committed Jun 14, 2016
1 parent a755f77 commit f06f3eb
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ Check the results of this simple project:
![](screenshots/animation-pink.gif)

##### See it live at [pixelart-to-css-react](http://pixelart.jvrpath.com/)
#### Help me to improve it, share and enjoy :)

## Technical overview

This application has been built with the following technoligies:
This application has been built with the following technologies:

- [React](https://facebook.github.io/react/) (Library to build the UI)
- [Redux](http://redux.js.org/) (Implement Flux architecture)
- [React](https://facebook.github.io/react/): Library to build the UI
- [Redux](http://redux.js.org/): Implements a Flux like architecture
- [ImmutableJS](https://facebook.github.io/immutable-js/) Helps to keep the data immutable
- [PostCSS](https://github.com/postcss/postcss) Handle the app CSS
- [NodeJS](https://nodejs.org/en/) + [Express](http://expressjs.com/) (Server side to build an universal application, create and serve the generated drawings)

## Installation
Expand All @@ -44,15 +44,15 @@ npm run install

## Development

If you just want to develop the interface with no need of back-end side, taking advance of ```webpack-dev-server``` and ```react-hot-loader```.
If you just want to develop the interface with no need of back-end side, take advance of ```webpack-dev-server``` and ```react-hot-loader```.

```bash
npm run development
```

## Deploy

Create the final build and run the generated react html on a express server making in an isomorphic/universal way.
Create the final build and run the generated react html on a express server making in an isomorphic way.

```bash
npm run deploy
Expand All @@ -67,3 +67,13 @@ A ```config.json``` is needed for deployment with the Twitter and express keys.
```bash
npm run test
```

## Contributing
#### Help me to improve it, share and enjoy :)
Please create a Github issue if there is something wrong or to be improved. Pull request are also welcome and they can be created to the develop branch.


## License

[MIT](https://opensource.org/licenses/mit-license.php)
Copyright © 2016 Javier Valencia Romero (@jvalen)

0 comments on commit f06f3eb

Please sign in to comment.