OLD | NEW |
1 This is the server that will be used on `pub.dartlang.org` as the default | 1 This is the server that will be used on `pub.dartlang.org` as the default |
2 package repository for the Pub package manager. | 2 package repository for the Pub package manager. |
3 | 3 |
4 For license information, please see LICENSE. | 4 For license information, please see LICENSE. |
5 | 5 |
6 ### Repository Structure | 6 ### Repository Structure |
7 | 7 |
8 pub_dartlang.py The entry point for running the app. | 8 pub_dartlang.py The entry point for running the app. |
9 app.yaml App Engine configuration. | 9 app.yaml App Engine configuration. |
10 third_party/ External dependencies, included in the repo so that App | 10 third_party/ External dependencies, included in the repo so that App |
(...skipping 22 matching lines...) Expand all Loading... |
33 | 33 |
34 [app engine sdk]: https://developers.google.com/appengine/downloads | 34 [app engine sdk]: https://developers.google.com/appengine/downloads |
35 | 35 |
36 * Open your browser to <http://localhost:8080/> to see that it works. | 36 * Open your browser to <http://localhost:8080/> to see that it works. |
37 | 37 |
38 * To run tests: | 38 * To run tests: |
39 | 39 |
40 ./test.py | 40 ./test.py |
41 | 41 |
42 * To publish packages to your local test server, visit <http://localhost:8080/
admin> | 42 * To publish packages to your local test server, visit <http://localhost:8080/
admin> |
43 (sign in as administrator), go to the "Private Key" tab & enter any string | 43 (sign in as administrator), go to the "Private Key" tab & enter any string |
44 into the private key field. | 44 into the private key field. |
45 | 45 |
46 <sup>1</sup> This might have been done already if you allowed the Google App | 46 <sup>1</sup> This might have been done already if you allowed the Google App |
47 Engine launcher to add symbolic links to your `$PATH`. | 47 Engine launcher to add symbolic links to your `$PATH`. |
48 | 48 |
49 <sup>2</sup> On installing packages: | 49 <sup>2</sup> On installing packages: |
50 * Beautiful Soup & WebTest are only required for running tests. | 50 * Beautiful Soup & WebTest are only required for running tests. |
51 * Some Linux distributions come with PyCrypto installed by default. Make sure | 51 * Some Linux distributions come with PyCrypto installed by default. Make sure |
52 at least version 2.6 installed. | 52 at least version 2.6 installed. |
53 * If using Mac and `pip` is not available, install [brew](http://brew.sh) and | 53 * If using Mac and `pip` is not available, install [brew](http://brew.sh) and |
54 run `brew install python`. | 54 run `brew install python`. |
55 | 55 |
56 ### Deploying | 56 ### Deploying |
57 | 57 |
58 See the docs on [branches and versions][]. | 58 See the docs on [branches and versions][]. |
59 | 59 |
60 [branches and versions]: https://github.com/dart-lang/pub-dartlang/wiki/Branches
-and-Versions | 60 [branches and versions]: https://github.com/dart-lang/pub-dartlang/wiki/Branches
-and-Versions |
61 | 61 |
62 ### Modifying the CSS and Documentation | 62 ### Modifying the CSS and Documentation |
63 | 63 |
64 The CSS files are generated from the source [Sass][] files using [Compass][]. | 64 The CSS files are generated from the source [Sass][] files using [Compass][]. |
65 The HTML documentation files are generated from the source [Markdown][] using | 65 To get ready to make changes, you'll need [Ruby][] and [Python][]. Then: |
66 [Jekyll][]. To get ready to make changes, you'll need [Ruby][] and [Python][]. | |
67 Then: | |
68 | 66 |
69 [ruby]: http://ruby-lang.org | 67 [ruby]: http://ruby-lang.org |
70 [python]: http://python.org | 68 [python]: http://python.org |
71 [sass]: http://sass-lang.com | 69 [sass]: http://sass-lang.com |
72 [compass]: http://compass-style.org | 70 [compass]: http://compass-style.org |
73 [markdown]: http://daringfireball.net/projects/markdown/ | |
74 [jekyll]: http://jekyllrb.com/ | |
75 | 71 |
76 1. Ensure you have bundler installed: | 72 1. Ensure you have bundler installed: |
77 | 73 |
78 gem install bundler | 74 gem install bundler |
79 | 75 |
80 2. Run this to install the dependencies: | 76 2. Run this to install the dependencies: |
81 | 77 |
82 bundle install | 78 bundle install |
83 | 79 |
84 3. Run this to install the latest version of Pygments for syntax highlighting: | 80 3. Run this to install the latest version of Pygments for syntax highlighting: |
85 | 81 |
86 sudo pip install --upgrade pygments | 82 sudo pip install --upgrade pygments |
87 | 83 |
88 Note that this is only needed on your development machine to iterate on the CSS | 84 Note that this is only needed on your development machine to iterate on the CSS.
The deployed server just uses the pre-compiled CSS and only requires Python. |
89 and documentation. The deployed server just uses the pre-compiled CSS and HTML | |
90 and only requires Python. | |
91 | 85 |
92 Once you have everything installed, to modify the styles and documentation: | 86 Once you have everything installed, to modify the styles: |
93 | 87 |
94 1. Run [Foreman][] to automatically regenerate the CSS and HTML files when any | 88 1. Run [Foreman][] to automatically regenerate the CSS files when any Sass |
95 Sass or Markdown files change: | 89 files change: |
96 | 90 |
97 bundle exec foreman start | 91 bundle exec foreman start |
98 | 92 |
99 1. Edit the `.scss` files under `css/sass` and the `.markdown` files under | 93 1. Edit the `.scss` files under `css/sass`. |
100 `doc`. | |
101 | 94 |
102 [foreman]: http://ddollar.github.com/foreman/ | 95 [foreman]: http://ddollar.github.com/foreman/ |
103 | 96 |
104 When you make changes to SCSS or Markdown files, make sure to check in the | 97 When you make changes to SCSS files, make sure to check in the generated CSS |
105 generated CSS or HTML files with them. | 98 files with them. |
OLD | NEW |