https://github.com/mozilla/womenandweb

INACTIVE - http://mzl.la/ghe-archive - This repository hosts the code used to power the Women and Web Literacy hub's website
https://github.com/mozilla/womenandweb

inactive unmaintained

Last synced: 4 months ago
JSON representation

INACTIVE - http://mzl.la/ghe-archive - This repository hosts the code used to power the Women and Web Literacy hub's website

• Host: GitHub
• URL: https://github.com/mozilla/womenandweb
• Owner: mozilla
• License: mpl-2.0
• Archived: true
• Created: 2016-08-03T20:56:35.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-03-29T22:01:57.000Z (about 6 years ago)
• Last Synced: 2025-01-16T16:26:36.299Z (4 months ago)
• Topics: inactive, unmaintained
• Language: CSS
• Homepage: https://mozilla.github.io/womenandweb
• Size: 3.23 MB
• Stars: 8
• Watchers: 40
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Women and Web Literacy

[![Build Status](https://travis-ci.org/mozilla/womenandweb.svg)](https://travis-ci.org/mozilla/womenandweb)

[![Dependency Status](https://david-dm.org/mozilla/womenandweb.svg)](https://david-dm.org/mozilla/womenandweb)

[![Dev Dependency Status](https://david-dm.org/mozilla/womenandweb/dev-status.svg)](https://david-dm.org/mozilla/womenandweb/?type=dev)

[![Uses Mofo Standards](https://MozillaFoundation.github.io/mofo-standards/badge.svg)](https://github.com/MozillaFoundation/mofo-standards)

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](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](https://mozilla.github.io/womenandweb/).

#### 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.