https://github.com/z0u/cargo-web
https://github.com/z0u/cargo-web
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/z0u/cargo-web
- Owner: z0u
- Created: 2015-09-20T15:04:01.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-09-22T02:55:09.000Z (almost 11 years ago)
- Last Synced: 2023-08-07T10:56:44.258Z (almost 3 years ago)
- Language: CSS
- Size: 12.5 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
The Cargo Website
=================
For better or worse, this is a website built with the Pelican static website
generator.
Put standard pages in the `content/pages` directory as Markdown or
reStructuredText. Put blog entries at the root of `content`. These are then
turned into HTML by Pelican and dumped into the `output` directory.
The custom HTML on the home page as well as the other branding and CSS is in
`themes`.
Installing requirements
-----------------------
There are a few steps you'll need to perform once to work with this website::
1. Install the required system packages::
$ sudo apt-get install fabric python-pip python-virtualenv \
virtualenvwrapper ruby ruby-dev fontforge ttfautohint woff-tools
$ sudo gem install fontcustom
TODO: Update instructions to use RBM or so instead of global install.
2. We'll install the relevant Python packages into a virtualenv. You can do this
using the standard `virtualenv` command, but `virtualenvwrapper` makes it a
little easier by providing the `mkvirtualenv` and `workon` commands.
Create a Python virtual environment to store downloaded packages in::
$ virtualenv cargo
3. Now activate the virtual environment::
$ . cargo/bin/activate
4. Download and install the required Python packages::
(cargo)$ pip install -r requirements.txt
This refers to the `requirements.txt` file in the website directory.
Building the website
--------------------
Before you build the website, you need to first activate the virtual
environment as above.
Then we run Pelican to build the static website from your source files. There's
a single command way to do this, but I've found it a bit unreliable.
In one shell run the command to watch the source files and rebuild the static
pages into the `output` directory::
(cargo)$ make regenerate
In another, run the mini web-server that serves the files from `output`::
(cargo)$ make serve
You can now browse the site at `http://localhost:8000/`.
Uploading the website
---------------------
Use rsync to copy the output directory to the remote web server::
$ rsync -avz --exclude=releases output/ cargo-web@lille.sturm.com.au:/home/web/cargo/htdocs
Uploading software releases
---------------------------
Copy resources to the static/releases directory on the server::
$ rsync -avz --progress *.zip *.bz2 cargo-web@lille.sturm.com.au:/home/web/cargo/htdocs/static/releases/