Skip to content

Latest commit

 

History

History
170 lines (122 loc) · 5.91 KB

README.md

File metadata and controls

170 lines (122 loc) · 5.91 KB
Raw

newhaven.io

This is the code for the newhaven.io website. It's just a placeholder right now. If you'd like to help build the site (and the New Haven hacker community) please get in touch. You can find fellow New Haven hackers via

Quickstart (OS X)

For impatient people, this should work.

git clone https://github.com/newhavenio/newhavenio-website
cd newhavenio-website

brew install node
brew install mongodb
brew install phantomjs

gem install bundler
bundle

foreman start -f Procfile.dev

Requirements

The newhaven.io website is an Express application that is hosted on Heroku. We use a variety of tools to build the app, including Sass, Yeoman, Bower, Grunt, and Yeoman's Angular Generator.

To make changes to the website, you'll need a few tools in your environment, mostly Yeoman, Bower, Grunt and their dependencies, all of which are based on the node.js stack. The following instructions will help you install those tools. (These instructions are a tad pedantic for the benefit of those who would like to contribute but perhaps have less development experience.)

Installing node and npm

If you're on a mac, it's likely easiest to install node via homebrew. If you're on another *nix machine, you can likely figure this out for yourself. If you're on windows, you're on your own.

brew install node

Then, you'll need to install npm, the node package manager.

echo 'export PATH=$HOME/local/bin:$PATH' >> ~/.bashrc
. ~/.bashrc
mkdir ~/local
mkdir ~/node-latest-install
cd ~/node-latest-install
curl http://nodejs.org/dist/node-latest.tar.gz | tar xz --strip-components=1
./configure --prefix=~/local
make install
curl https://www.npmjs.org/install.sh | sh

Checking out this repo

First, you'll need to check out this repository.

git clone https://github.com/newhavenio/newhavenio-website
cd newhavenio-website

Installing the dependencies

All the dependencies are under version control, so you shouldn't need to npm install anything.

Developing

Working on the site

You can preview any changes you're making live by running

foreman run grunt server

This will open up a browser window and automatically refresh as you make changes to different files. If you run the server like that, you'll also need to be running Mongodb via the mongod command. Alternatively, you can run both MongoDB and the server using the following command

foreman start -f Procfile.dev

(See the contents of the Procfile.dev file.)

Environment variables

If you encountered an exception starting the server, it's likely that your environment is missing some required variables. You should keep these variables in a .env file, so that foreman will source them automatically. Your .env should contain the following:

GITHUB_CLIENT_ID=PUT-SOME-THING-HERE
GITHUB_CLIENT_SECRET=PUT-SOME-THING-HERE
GITHUB_CALLBACK_URL=http://localhost:9000/auth/callback
MONGOHQ_URL=mongodb://localhost/newhaven-io
COOKIE_SECRET=whatever-doesnt-matter-locally
KNOWN_ADMINS=your-github-login

If you want to test the GitHub Oauth, you'll need to set up a GitHub application here and stick the credentials GitHub gives you in the GITHUB_* variables. Obviously, you can change the value of the MONGOHQ_URL, COOKIE_SECRET and KNOWN_ADMINS to be whatever you want. (The latter parameter is a comma-delimited list of GitHub users that should receive the "admin" role in the NewHaven.io app.)

Testing the site

There are a handful of tests, just for grins. To run these, you'll need PhantomJS, which you can install by running

brew install phantomjs

Then, you can run the tests like

grunt test

Deploying the site

The site is hosted on Heroku. Only a few people can deploy, please contact Kyle, Joel, or Chris.

Contributors

The following people generously donated their time to building the newhaven.io website. You should generously donate yours too!

License

Copyright (c) 2013 the Contributors (see above)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.