The website behind the robot behind the legend behind the nonsense.
Gods help us all.
This application is written in Node and uses Redis for persistence. To install these in OS X, install Homebrew first and then run
$ brew install redis
$ brew install node
This will install both of the requirements. The remaining requirements will be installed by the application layer.
- We use Sass as the CSS language, and CSS is stored in /assets/css in the repository, served at
http://...../assets/css/main.css
- We use Handlebars templates, in /views running inside the
main
layout in /views/layouts - Handlebars integration is provided with the express-handlebars package
- Anything placed in /public is accessible on the site as
/static/..
- The production site runs in Heroku
- 🐈 Planet
That's about it. If something is stupid or confusing, FILE A FUCKING ISSUE so that it can get fixed.
First, clone the repository, and set the name of the remote to upstream
. This will become useful when you fork the repository to contribute changes.
$ git clone https://github.com/desert-planet/ayp
$ cd ayp
$ git remote rename origin upstream
Now use npm, which should have been installed with node, to install the application and all of its dependencies.
$ npm install
If nothing goes wrong, you can then load the local database with some test strips after loading the dev environment.
$ . script/ayp-env
$ script/db-seed
=> I'm gonna stuff your DB with some content.
[..snip..]
Now you're GOOD TO GO. To run the development server
$ npm start
Your pants running at http://localhost:5000/
If you wish to see your changes reloaded on the server, use npm run watch
If you have already created a fork, you can add that remote as origin
$ git remote add origin https://github.com/your_name_here/ayp
So that newly created branches will push to your fork, but switching to master
and running git pull
will get the latest changes from the upstream repository.