/website-frontend

Web Application for Stories of Solidarity

Primary LanguageJavaScriptOtherNOASSERTION

Stories of Solidarity

A social media tool that helps workers in low wage, precarious jobs to build new forms of solidarity and mutual aid.

Frontend

This is a static site to pull stories from the database and display them visually. Provides user login capability and new story additions, sending submissions over the API to be saved in the database.

Technologies

Development

We use Bower as our front-end package manager.

$ npm install bower -g
$ bower install

We use Grunt as our task runner. Get the CLI (command line interface) and install it globally, and any other devDependencies locally.

$ npm install grunt-cli -g
$ npm install

Now compile and serve the site locally. This will watch for changes as you make them and reload them in the browser window.

$ grunt serve --watch

You may also want to run the story-database and us-data servers locally for a complete development stack. If you don't, comment out the Solidarity.apiRoot and dataRoot settings in index.html to use the production endpoints.

To add new icons to the custom font, put the SVG file in /app/images/icons and re-run fontcustom compile from the repository root.

Deployment

Using GitHub Pages, build and push the resulting dist directory to the gh-pages branch.

$ grunt build
$ grunt buildcontrol:live