https://github.com/commonsearch/cosr-about

"About" static website for Common Search
https://github.com/commonsearch/cosr-about

Last synced: 5 days ago
JSON representation

"About" static website for Common Search

• Host: GitHub
• URL: https://github.com/commonsearch/cosr-about
• Owner: commonsearch
• License: apache-2.0
• Created: 2016-02-28T16:16:00.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-12-09T21:24:28.000Z (almost 8 years ago)
• Last Synced: 2024-08-01T12:28:27.574Z (3 months ago)
• Language: HTML
• Homepage: https://about.commonsearch.org/
• Size: 1.17 MB
• Stars: 11
• Watchers: 3
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - commonsearch/cosr-about - "About" static website for Common Search (others)

README

        
# cosr-about

[![Chat with us on Slack](https://slack.commonsearch.org/badge.svg)](https://slack.commonsearch.org) [![Apache License 2.0](https://img.shields.io/github/license/commonsearch/cosr-back.svg)](LICENSE)

This repository contains our presentation website and blog hosted at https://about.commonsearch.org/.

You can use the [issues page](https://github.com/commonsearch/cosr-about) to suggest improvements to the content or layout!

## Local install with Docker

Running `cosr-about` on your local machine is very simple. You only need to have [Docker](https://docs.docker.com/engine/installation/) installed.

Once Docker is launched, just run:

```

make docker_devserver

```

Then open http://192.168.99.100:9701/ in your browser. (Replace "192.168.99.100" by the address of your Docker machine. On a Mac, you can get it with `docker-machine ip boot2docker`)

## Alternate install without Docker

If for some reason you don't want to use Docker, you might be able to use your local Python install to run `cosr-about`. Please note that this is an unsupported method and might break at any time.

```

make virtualenv

make devserver

```

Then open http://localhost:9701/

## Tech details

This website uses [Pelican](http://blog.getpelican.com/) to statically generate a bunch of HTML files from [Markdown](http://commonmark.org/) source.

We use a customized [Bootstrap 3](http://getbootstrap.com/) template. We welcome any contributions to make it prettier!