BrazilJS.org

Build Status Dependency Status DevDependencies Status

Cover

A non-profit foundation with a mission to move and unify JavaScript community in Brazil.

Maintainer: Diogo Moretti

Contributing

There are tons of ways to contribute to this project.

Submit an event to braziljs.org/eventos

This is a list of all brazilian front-end conferences that happened or will happen this year.

  1. Edit the JSON file in src/files/services/events.
  2. Provide a thumbnail (227x200) in src/files/services/events/media.
Submit a project to braziljs.org/projetos
  1. Create a new HTML file named by name-of-project.html in src/documents/projetos and fill with the code below changing for yours project infos.
---
title: "Title of project"
description: "Description of project"
site: "http://link-of-project.com.br"
github: "your github link (after github.com)"
image: "http://braziljs.org/img/projects/name-of-image-step2.jpg"
---

<ul>
  <li><a href="http://myurl.com">Description of link</a></li>
  (Add new li>a node to create new links)
</ul>
  1. Provide a thumbnail (250x200) in src/files/img/projects.

Dependencies

  1. Install Git, if you don't have it yet.
  2. Install NodeJS, if you don't have it yet.

Setup

Once you have all dependencies installed, you just need to:

  1. Open your terminal and clone the project.
$ git clone git@github.com:braziljs/braziljs.org.git
  1. Then go to the project's folder.
$ cd braziljs.org
  1. Initialize the submodules.
$ git submodule update --init
  1. And install local dependencies.
$ npm install

Usage

Execute the command below to generate the website into out directory:

$ npm run build

Generate and watch for any changes in http://localhost:9778:

$ npm run watch

Generate and deploy to gh-pages branch:

$ npm run deploy

License

MIT License © BrazilJS Foundation