README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

# Git Homepage [![Build Status](https://travis-ci.org/git/git-scm.com.png?branch=master)](https://travis-ci.org/git/git-scm.com)

This is the web application for the [git-scm.com](http://git-scm.com) site.  It is meant to be the
first place that a person new to Git will land and download or learn about the
Git SCM system.

This app is written in Ruby on Rails and deployed on Heroku.

## Setup

You'll need a Ruby environment to run Rails.  First do:

    $ rvm use 1.9.2
    $ bundle install

Then you need to create the database structure:

    $ rake db:migrate

Now you'll want to populate the man pages.  You can do so from a local Git
source clone like this:

    $ GIT_REPO=../git/.git rake local_index

Or you can do it from GitHub (much slower) like this:

    $ rake preindex

Now you need to get the latest downloads for the downloads pages:

    $ rake downloads

Now you'll probably want some book data. You'll have
to have access to the progit project on the Github through the API.

    $ export API_USER=github_username
    $ export API_PASS=github_password
    $ rake remote_genbook

That will generate the book content from the markdown files fetched from the online repository  and post it to the Rails server database.

Now you can run the Rails site to take a look.  Specify an UPDATE_TOKEN so you
can use the world's stupidest authentication mechanism:

    $ UPDATE_TOKEN=something rails server

The site should be running on http://localhost:3000


## Testing

To run the tests for this project, run:

    $ rake test

To run the website for testing purposes, run:

    $ bundle exec rackup config.ru

## Contributing

If you wish to contribute to this website, please [fork it on GitHub](https://github.com/github/git-scm.com), push your
change to a named branch, then send me a pull request. If it is a big feature,
you might want to contact me first to make sure it's something that I'll
accept.  If it involves code, please also write tests for it.

## License

This source code for the site is licensed under the MIT, which you can find in
the MIT-LICENSE.txt file.

All graphical assets are licensed under the
[Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).