Women and Web Literacy

This repository hosts the code used to power the Women and Web Literacy hub's website.

Development

Setup

Requirements: Node, npm, git.

Run the following terminal commands to get started:

git clone https://github.com/mozilla/womenandweb.git
cd womenandweb
npm start

This will install all dependencies, build the code, start a server at http://127.0.0.1:2040, and launch it in your default browser.

File Structure

.
├── dest <- Compiled code generated from source. Don't edit!
├── scripts <- Scripts run by npm tasks
└── source <- Source code
    ├── images <- Image assets
    ├── index.pug <- Pug/Jade template for index page
    ├── markdown <- Markdown partials
    └── sass <- Sass code

Deployment

Production

Any commits to the master branch on this repo will trigger an automatic build and deploy to GitHub Pages.

Staging

There is currently no common staging environment for this project. However, you can easily deploy a staged build to your own fork using the following command: npm run stage REMOTE. Be sure to substitute REMOTE with the name of your personal remote. Also, be sure not to have npm start or npm server running when you run the staging command.

Once this task completes, your currently checked out branch will be available at:

https://USERNAME_FOR_REMOTE.github.io/womenandweb

Note: It can take a minute for changes to become available.

mozilla / womenandweb