tsurupin/portfolio

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![CircleCI](https://circleci.com/gh/tsurupin/portfolio.svg?style=svg)](https://circleci.com/gh/tsurupin/portfolio)
[![Code Climate](https://codeclimate.com/github/tsurupin/portfolio/badges/gpa.svg)](https://codeclimate.com/github/tsurupin/portfolio)

# [Portfolio](http://staging.tsurupin.com)



**Portfolio** is a simple blog and portfolio CMS written in [React](https://facebook.github.io/react/)/[Redux](http://redux.js.org/)(Frontend) and [Rails](http://rubyonrails.org/)(API)


Demo
-------
![](https://cloud.githubusercontent.com/assets/1782169/17211740/27c54d5a-5506-11e6-8bb3-fc89a71c718b.gif)
### client
Live version: [http://staging.tsurupin.com](http://staging.tsurupin.com)


![](https://cloud.githubusercontent.com/assets/1782169/17213387/2d61cda2-550f-11e6-95a7-42f0899546b1.gif)

### cms

Live version: [http://staging.tsurupin.com/cms](http://staging.tsurupin.com/cms)

#### sample account
You can sign in to the demo account with the following info.
<table>
  <thead>
    <tr>
      <th>Email</th>
      <th>Password</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>sample@gmail.com</td>
      <td>sample_password</td>
    </tr>
  </tbody>
</table>

**All the data in the demo are dummy.*

Motivation
-------
I created this app for the reason I wanted to make my own blog and learn full Redux based application with Rails api.

Main Technology Stack
-------
* React
* Redux
* Rails
* CSS Modules
* Material-UI


Development
--------

### Setup
1. Get the code.

        % git clone git@github.com:tsurupin/portfolio.git

2. Setup your environment.

        % bin/setup

3. Start Foreman.

        % foreman start

4. Verify that the app is up and running.

        % open http://localhost:3000

### Style Guides
**Portfolio** refers to the following style guides in each language and framework.

 - [ES6](https://github.com/airbnb/javascript)
 - [React](https://github.com/airbnb/javascript/tree/master/react)
 - [Ruby](https://github.com/airbnb/ruby)
 - [Rails](https://github.com/thoughtbot/guides/tree/master/style/rails)


Todo
-------
 1. Upgrade Rails version to Rails 5.
 2. Improve SEO.
 3. Add comment function.


License
-------
 The project is available as open source under the terms of the MIT License.


Troubleshooting
-------
 Please create an [issue](https://github.com/tsurupin/portfolio/issues).