https://github.com/dvcrn/proxmate.me

Source code for https://proxmate.me
https://github.com/dvcrn/proxmate.me

Last synced: 6 days ago
JSON representation

Source code for https://proxmate.me

• Host: GitHub
• URL: https://github.com/dvcrn/proxmate.me
• Owner: dvcrn
• Created: 2014-02-09T14:41:35.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-09-28T02:46:19.000Z (about 9 years ago)
• Last Synced: 2023-03-13T10:55:31.896Z (over 1 year ago)
• Language: CSS
• Homepage: https://proxmate.me
• Size: 1.18 MB
• Stars: 9
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# The code has been moved. This version is no longer maintained.

# proxmate.me

[![Built Status](https://travis-ci.org/dvcrn/proxmate.me.png "Build Status")](https://travis-ci.org/dvcrn/proxmate.me/)

This is the sourcecode for the [proxmate.me](https://proxmate.me). proxmate.me has been designed to be completely static and can be served by any static webserver (such as s3). 

## Serving

Run `grunt serve` to spawn a static, self-reloading webserver. 

## Building

We are using Grunt for building. Make sure you have all dependencies (bower + npm) installed, then run `grunt build`. 

To deploy to s3, make sure that `grunt-aws.json` contains your aws credentials, then run `grunt deploy`. 

## Prerendering

Since javascript is hard to index, proxmate.me is using a prerender script to generate static html pages that are being served. To prerender, make sure that your latest source is deployed somewhere (s3 for example), then execute `grunt freeze`. This will generate a static html for every html page listed inside [api.proxmate.me](https://api.proxmate.me/url/list.json). 

## Contributing

- make sure that your code is tested

- make sure all existing unit tests pass (`grunt test`).