Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zhaoda/spring

Spring is a blog engine written by GitHub Issues
https://github.com/zhaoda/spring

Last synced: 3 months ago
JSON representation

Spring is a blog engine written by GitHub Issues

Host: GitHub
URL: https://github.com/zhaoda/spring
Owner: zhaoda
License: mit
Created: 2014-02-20T14:54:05.000Z (about 11 years ago)
Default Branch: master
Last Pushed: 2016-09-19T16:18:55.000Z (over 8 years ago)
Last Synced: 2024-10-30T06:33:27.754Z (4 months ago)
Language: JavaScript
Homepage: http://zhaoda.net/spring/
Size: 427 KB
Stars: 94
Watchers: 9
Forks: 114
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Spring [![Build Status](https://img.shields.io/travis/zhaoda/spring.svg)](https://travis-ci.org/zhaoda/spring)

Spring is a blog engine written by GitHub Issues, or is a simple, static web site generator. No more server and database, you can setup it in free hosting with GitHub Pages as a repository, then post the blogs in the repository Issues.

You can add some labels in your repository Issues as the blog category, and create Issues for writing blog content through Markdown.

Spring has responsive templates, looking good on mobile, tablet, and desktop.Gracefully degrading in older browsers. Compatible with Internet Explorer 10+ and all modern browsers.

Get up and running in seconds.

[中文介绍](http://zhaoda.net/2014/03/21/%E4%BD%BF%E7%94%A8Spring%E5%BF%AB%E9%80%9F%E6%90%AD%E5%BB%BA%E5%8D%9A%E5%AE%A2.html)

## Quick start guide

For the impatient, here's how to get a Spring blog site up and running.

### First of all

* Fork the [Spring](https://github.com/zhaoda/spring "Spring") repository as yours.
* Goto your repository settings page to rename `Repository Name`.
* Hosted directly on [GitHub Pages](http://pages.github.com "GitHub Pages") from your project repository, you can take it as *User or organization site* or *Project site(create a gh-pages branch)*.
* Also, you can [set up a custom domain with Pages](https://help.github.com/articles/setting-up-a-custom-domain-with-pages).

### Secondly

* Open the `index.html` file to edit the config variables with yours below.

```javascript
$.extend(spring.config, {
// my blog title
title: 'Spring',
// my blog description
desc: "A blog engine written by github issues [Fork me on GitHub](https://github.com/zhaoda/spring)",
// my github username
owner: 'zhaoda',
// creator's username
creator: 'zhaoda',
// the repository name on github for writting issues
repo: 'spring',
// custom page
pages: [
]
})
```
* Put your domain into the `CNAME ` file if you have.
* Commit your change and push it.

### And then

* Goto your repository settings page to turn on the `Issues` feature.
* Browser this repository's issues page, like this `https://github.com/your-username/your-repo-name/issues?state=open`.
* Click the `New Issue` button to just write some content as a new one blog.

### Finally

* Browser this repository's GitHub Pages url, like this `http://your-username.github.io/your-repo-name`, you will see your Spring blog, have a test.
* And you're done!

## Custom development

### Installation

* You will need a web server installed on your system, for example, Nginx, Apache etc.
* Configure your spring project to your local web server directory.
* Run and browser it, like `http://localhost/spring/dev.html` .
* `dev.html` is used to develop, `index.html` is used to runtime.

### Folder Structure

### Customization

* Browser `http://localhost/spring/dev.html`, enter the development mode.
* Changes you want to modify the source code, like `css`, `js` etc.
* Refresh `dev.html` view change.

### Building

* You will need [Node.js](http://nodejs.org/ "Node.js") installed on your system.
* Installation package.

```bash
$ npm install
```
* Run grunt task.

```bash
$ grunt
```
* Browser `http://localhost/spring/index.html`, enter the runtime mode.
* If there is no problem, commit and push the code.
* Don't forget to merge `master` branch into `gh-pages` branch if you have.
* And you're done! Good luck!

## Report a bug

* Check if the bug is already fixed in the [master branch](https://github.com/zhaoda/spring/commits/master) since the last release.
* Check [existing issues](https://github.com/zhaoda/spring/issues).
* [Open a new one](https://github.com/zhaoda/spring/issues/new), including exact browser & platform information.

## Who used

* http://zhaoda.net/spring
* http://zhaoda.net/blog

If you are using, please [tell me](https://github.com/zhaoda/spring/issues/6).

## License

Spring is available under the terms of the [MIT License](https://raw.githubusercontent.com/zhaoda/spring/master/LICENSE "MIT License")