Skip to content

Latest commit

 

History

History
309 lines (209 loc) · 11.3 KB

README-pt.md

File metadata and controls

309 lines (209 loc) · 11.3 KB
Raw

Read the documentation in English

Conf Boilerplate Build Status

image

Uma iniciativa da BrazilJS Foundation para ajudar aqueles que querem organizar conferências/eventos e não tem muito tempo para criar o site disso.

Mantenedor: Jean Carlo Emer

Índice

Como funciona?

image

Nós usamos o DocPad, um static generator em NodeJS, para criar esse modelo extremamente simples de customizar. Além disso, a hospedagem é gratuita via GitHub Pages e você ainda pode usar seu próprio domínio (mais informações sobre isso em Deploy).

Por padrão, definimos as seguintes seções:

  • About - Para que você possa descrever o objetivo do seu evento.
  • Location - Para que você possa exibir a localização do seu evento através do Google Maps.
  • Speakers - Para que você possa listar informações sobre os palestrantes.
  • Schedule - Para que você possa mostrar a agenda do evento.
  • Sponsors - Para que você possa fazer propaganda dos seus patrocinadores.
  • Partners - Para que você possa fazer propaganda dos seus apoiadores.

OBS 1: Não há integração com nenhum sistema de inscrição e/ou pagamento. Por conta disso, indicamos o Eventick.

OBS 2: Por enquanto ainda não conseguimos desenvolver uma solução altamente automatizada e customizável para formulários de contato. Por conta disso, indicamos o Wufoo.

Primeiros passos

Pré-requisitos: Instale o Git e o NodeJS, caso você não os tenha ainda.

  1. Instale Git e NodeJS, caso você não os tenha ainda.

  2. Clone o repositório:

    $ git clone git://github.com/braziljs/conf-boilerplate.git

  3. Vá para pasta do projeto:

    $ cd conf-boilerplate

  4. Instale todas as dependências:

    $ npm install

  5. E finalmente rode:

    $ npm run-script watch

Agora você irá ver o site rodando em localhost:9778 :D

Estrutura

A estrutura básica do projeto se dá na seguinte forma:

.
|-- out/
|-- src/
|   |-- documents
|   |-- layouts
|   |-- partials
|-- docpad.js
|-- package.json
`-- publish.sh

out/

É onde os arquivos gerados são armazenados, uma vez que o DocPad tenha sido rodado. Porém, esse diretório se torna desnecessário no versionamento, por isso está ignorado (.gitignore).

src/documents

Contém o arquivo responsável por importar todas as seções da aplicação. Além disso contém o tema com todos seus arquivos como imagens, arquivos CSS e JS.

src/layouts

Contém o template padrão da aplicação.

src/partials

São blocos de código utilizados para gerar a página principal do site (index.html).

docpad.js

Armazena de forma fácil a maior parte das configurações da aplicação.

package.json

Lista as dependências de módulos do NodeJS.

publish.sh

Shell Script responsável pela publicação do site via GitHub Pages.

Customização

O projeto já vem com um template visual pronto, use-o à vontade, mas nós recomendamos que você crie seu próprio, a fim de colocar sua própria cara no evento.

De qualquer forma, nós preparamos algo altamente customizável para você, portanto para maioria das alterações do projeto basta ir até o docpad.js e alterar o valor das variáveis.

Informações básicas sobre a conferência

Quer alterar o nome, data, endereço, cidade ou preço do evento? É só mudar.

conf:
    name: "Conference name"
    description: "Conference description"
    date: "November 15"
    price: "$100"
    address: "Boulevard Kukulcan, 30, México"
    venue: "Coco Bongo"
    city: "Cancún"

Informações básicas sobre o site

Quer mudar a imagem de capa, código do Google Analytics ou o favicon? Vá em frente!

site:
    theme: "yellow-swan"
    url: "http://braziljs.github.io/conf-boilerplate/"
    googleanalytics: "UA-33656081-1"

Seções ativas

Ainda não definiu a programação completa do evento? Não tem problema, basta comentar a linha schedule (usando #).

Ainda não sabe quem irá palestrar? Tudo bem, basta comentar a linha speakers (usando #).

E por aí vai.

sections: [
  "about"
  "location"
  #"speakers"
  #"schedule"
  "sponsors"
  "partners"
  "contact"
]

Você ainda pode trocar a order em que eles aparecem na página e na navegação ao trocar a order das linhas também!

Labels (i18n)

Se você quiser usar palavras diferentes do padrão ou diferentes línguas é só trocar o valor das labels correspondentes:

labels:
  about: "Sobre"
  location: "Localização"
  speakers: "Palestrantes"
  schedule: "Agenda"
  sponsors: "Patrocinadores"
  partners: "Parceiros"
  contact: "Contato"

Você ainda pode usar esse objeto para definir outras labels que você gostaria de acessar nos seus templates.

Lista de Palestrantes

Para incluir/alterar/excluir um palestrante também é igualmente simples, basta recorrer ao schedule.

schedule: [
    name: "Chuck Norris"
    photo: "http://f.cl.ly/items/2A3p1N0C3c0n3N3R1w2B/speaker.jpg"
    bio: "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo"
    company: "Delta Command"
    twitter: "littlechuck"
    presentation:
        title: "How to kill a elephant with one finger"
        description: "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo"
        time: "13h00"
]

Quer listar mais algum atributo do palestrante que não está ali? Tudo bem, é só adicionar no docpad.js e depois exibí-lo com <%= speaker.seuNovoAtributo %> no speakers.html.eco.

Lista de outros itens da Agenda

Para alterar os horários de check-in, almoço e coffee-break, é só recorrer as variáveis de schedule.

schedule: [
    name: "Check-in / Breakfast"
    time: "9h00"
]

Mas se você quiser adicionar mais um coffee-break ou qualquer outro tipo de item na agenda do evento, é só acrescentar mais um item nessa lista.

Lista de Patrocinadores/Apoio

Para adicionar qualquer patrocinador ou apoio no evento, é só recorrer as variáveis sponsors e partners.

partners: [
    name: "BrazilJS"
    logo: "http://f.cl.ly/items/2N3i2W0X2f3c2g2Z2N0f/Untitled-1.png"
    url: "http://braziljs.org"
]

Deploy

Nós não gostamos de centralizar o poder de deploy em uma pessoa, portanto utilizaremos o recurso de GitHub Pages que ainda é gratuito. Para realizar o deploy basta rodar:

$ npm run-script deploy

Espere alguns minutos até que o GitHub lhe envie um e-mail avisando que tudo ocorreu bem. Depois é só acessar: http://seuUsuario.github.com/seuFork

Domínio personalizado

Caso você não queira utilizar o domínio do GitHub, é possível usar seu próprio com alguns passos.

  1. Crie um arquivo CNAME na pasta src/files do seu projeto e preencha com o nome do seu domínio: seuevento.com.
  2. Altere o DNS do seu domínio seguindo as instruções do GitHub.

Como fazer Deploy sem utilizar GitHub Pages

Se você prefere utilizar seu próprio servidor para hospedar o site:

  • Rode npm run-script generate na raíz do projeto.

Esse comando irá gerar uma pasta out contendo apenas arquivos estáticos, depois é só fazer o upload do conteúdo dessa pasta para sua hospedagem.

Showcase

Confira os eventos que usaram esse projeto como pontapé inicial:

Criou um site usando o ConfBoilerplate? Nos avise =D

Forks

Contribuindo

Se quiser enviar um pull request, por favor faça-o na branch dev.

  • master contém a versão estável disso.
  • dev contém as funcionalidades que estão em desenvolvimento.

Quem está por trás disso?

Nós somos um grupo de desenvolvedores que passaram por muitas dificuldades organizando conferências pelo Brasil e agora queremos ajudar outras pessoas nesse árduo trabalho.

Criado por:

Agradecimento especial a todos os membros da comunidade pelos feedbacks e contribuições.

Licença

MIT License © BrazilJS Foundation