Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/evantahler/api-first

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/evantahler/api-first
Owner: evantahler
License: mit
Created: 2013-03-04T04:14:55.000Z (almost 12 years ago)
Default Branch: gh-pages
Last Pushed: 2018-03-06T20:26:00.000Z (almost 7 years ago)
Last Synced: 2024-05-01T23:24:42.611Z (8 months ago)
Language: Ruby
Homepage: api-first.com
Size: 28.8 MB
Stars: 35
Watchers: 8
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # api-first.com

Welcome to the git repository for `www.api-first.com`!

We've established API-first.com to evolve over time as teams experiment with our suggestions and share insights of their own.  You can contribute your thoughts, edits, comments, stories, and visions here. Feel free to challenge what we've written and share your learnings! 

## How can I help?

API-first will be stronger if we can learn from each other.  We invite you to contribue your experineces in the form of a blog post.  Please fork this repo and submit your new post in the form of a pull request.

Aside from content, there are 2 parts of the site that need the most help: the Community page and Illustrations.  If you've given a relevant talk or written a related blog post, please submit to our community page.  We also need help turning our ugly process flows into beautiful illustrations.  If that is something you can help with, please let us know!

To contribute, please fork the site and send us a pull request with your changes.  GitHub has some [excellent free tools to help you](https://help.github.com/articles/using-pull-requests).  I cannot guarantee that all content will make it into the site, but if enough folks think your contribution adds value, we will be sure to include it.  

## Where did the comments go?

Rather than have the community's knowledge burred in comments, we would rather let you contribute directly to the site.  This gives you first-class access to share what you know with the world.  Please contribute!

## How do I build the site?

[api-first.com](http://api-first.com) is a static site hosted by [GitHub pages](http://pages.github.com/).  We use [Jekyll](http://jekyllrb.com/) to build the site and test it locally.  Here's a quick guide:

- [fork the project](https://help.github.com/articles/fork-a-repo/)

- install [Ruby](http://www.ruby-lang.org/) (comes with OSX)

- [git](http://git-scm.com/) clone this project

- [install](http://gembundler.com/) bundler

- install the gems this project needs with `bundle install`

- run jekyll `jekyll serve --watch` which will run this site locally on port 4000.

- send your change in a [pull request](https://help.github.com/articles/using-pull-requests/), and once they are merged, your changes will be up on the site!