Skip to content

Commit

Permalink
Open sourced
Browse files Browse the repository at this point in the history
  • Loading branch information
blazeu committed Mar 5, 2018
1 parent 2e15a5e commit fad1f9f
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 28 deletions.
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
MIT License

Copyright (c) 2018 Surya Widi Kusuma
Copyright (c) 2017 Prototype Interactive

Permission is hereby granted, free of charge, to any person obtaining a copy
Expand Down
37 changes: 13 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,21 @@
# Gatsby React Boilerplate
# [Comic Frontier Catalog](https://cfx.surya.works)

### Requirements
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/blazeu/cf-catalog)

* [Node.js](http://nodejs.org): for all the magic
* [Gatsby](https://www.gatsbyjs.org/docs/)
[Comic Frontier](http://comifuro.net/) catalog as a progressive web app with offline capability and mobile-first design. All data is scraped from the [official catalog](https://catalog.comifuro.net/) and served as a static site.

### Features
## Tech Stack

* Basic configuration and folder structure
* Uses postcss and sass (with autoprefixer and pixrem)
* Uses [Bootstrap 4](http://getbootstrap.com/) grid
* Leaves the styling to you
* Uses data from local json files
* Contains Node.js server code for easy, secure, and fast hosting
* [SVG sprites](https://css-tricks.com/svg-sprites-use-better-icon-fonts/): Add your icons in `components/icon` as .icon files and use them.
* [**Gatsby**](https://www.gatsbyjs.org/) static site generator
* [**react-virtualized**](https://github.com/bvaughn/react-virtualized) efficient list rendering
* [**Bootstrap 4**](https://getbootstrap.com/) CSS framework

### How to proceed
## Developing

1. Prepare a coffee
1. Run: `npm i` to install the dependencies
1. Run: `npm run dev` to run Gatsby
1. You should see shortly some text that says `The development server is listening at: http://localhost:8000`. Open that address in your browser and…
1. Start coding!
1. Run: `npm install` to install the dependencies
2. Run: `npm run develop` to run Gatsby
3. It may take some time to optimizes and processes all of the images for the first time

### How to build
## Building

1. Run: `npm run build` to build website into `/public` folder

### Considerations

* **RTL**: The usual method of generating different css file for RTL pages (as seen in static-html-boilerplate) will not work out of the box here since Gatsby pulls all the css together, this means the RTL css will override the LTR one.
1. Run: `npm run build` to build website into /public folder
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"build": "gatsby build",
"extract": "node tools/extract.js"
},
"author": "Prototype Interactive",
"author": "blazeu <[email protected]>",
"license": "MIT",
"dependencies": {
"@fortawesome/fontawesome": "^1.1.4",
Expand Down Expand Up @@ -47,10 +47,10 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/PrototypeInteractive/gatsby-react-boilerplate.git"
"url": "git+https://github.com/blazeu/cf-catalog.git"
},
"bugs": {
"url": "https://github.com/PrototypeInteractive/gatsby-react-boilerplate/issues"
"url": "https://github.com/blazeu/cf-catalog/issues"
},
"homepage": "https://github.com/PrototypeInteractive/gatsby-react-boilerplate#readme"
"homepage": "https://github.com/blazeu/cf-catalog#readme"
}

0 comments on commit fad1f9f

Please sign in to comment.