{"id":15309090,"url":"https://github.com/marcelod/conf-boilerplate","last_synced_at":"2025-10-08T16:31:32.694Z","repository":{"id":5604606,"uuid":"6811709","full_name":"marcelod/conf-boilerplate","owner":"marcelod","description":"A kickstart to create websites for conference/events","archived":false,"fork":true,"pushed_at":"2012-11-22T03:09:43.000Z","size":2798,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-02T08:19:59.879Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://confboilerplate.com","language":"CoffeeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"braziljs/conf-boilerplate","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcelod.png","metadata":{"files":{"readme":"README-pt.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-11-22T10:54:14.000Z","updated_at":"2013-01-13T06:48:03.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/marcelod/conf-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcelod%2Fconf-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcelod%2Fconf-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcelod%2Fconf-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcelod%2Fconf-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcelod","download_url":"https://codeload.github.com/marcelod/conf-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235731934,"owners_count":19036827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-01T08:20:37.146Z","updated_at":"2025-10-08T16:31:32.371Z","avatar_url":"https://github.com/marcelod.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"*[Read the documentation in English](https://github.com/braziljs/conf-boilerplate/blob/master/README.md)*\n\n---\n\n# Conf Boilerplate\n\n![image](http://f.cl.ly/items/2i1m3z3i1a3Z0I1X472B/logo.jpg)\n\nUma iniciativa da [BrazilJS Foundation](http://braziljs.org) para ajudar aqueles que querem organizar conferências/eventos e não tem muito tempo para criar o site disso.\n\n* [Como funciona?](#como-funciona)\n* [Primeiros passos](#primeiros-passos)\n* [Estrutura](#estrutura)\n* [Customização](#customiza%C3%A7%C3%A3o)\n* [Deploy](#deploy)\n* [Showcase](#showcase)\n* [Quem está por trás disso?](#quem-est%C3%A1-por-tr%C3%A1s-disso)\n\n## Como funciona?\n\n[![image](http://f.cl.ly/items/1q3i0r3q0n3y1N070M47/Screen%20Shot%202012-11-16%20at%207.05.44%20PM.png)](http://www.youtube.com/watch?v=EI99oZI3nKY)\n\nNós usamos o [DocPad](https://github.com/bevry/docpad), um static generator em NodeJS, para criar esse modelo extremamente simples de customizar. Além disso, a hospedagem é gratuita via [Github Pages](http://pages.github.com) e você ainda pode usar seu próprio domínio *(mais informações sobre isso em [Deploy](#dom%C3%ADnio-personalizado))*.\n\nPor padrão, definimos as seguintes seções:\n\n* *About* - Para que você possa descrever o objetivo do seu evento.\n* *Location* - Para que você possa exibir a localização do seu evento através do Google Maps.\n* *Speakers* - Para que você possa listar informações sobre os palestrantes.\n* *Schedule* - Para que você possa mostrar a agenda do evento.\n* *Sponsors* - Para que você possa fazer propaganda dos seus patrocinadores.\n* *Partners* - Para que você possa fazer propaganda dos seus apoiadores.\n\n*OBS 1: Não há integração com nenhum sistema de inscrição e/ou pagamento. Por conta disso, indicamos o [Eventick](http://eventick.com.br/).*\n\n*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](http://wufoo.com/).*\n\n## Primeiros passos\n\n1. Instale o [Git](http://git-scm.com/downloads) e o [NodeJS](http://nodejs.org/download/), caso você não os tenha ainda.\n\n2. Abra o terminal e baixe o [DocPad](https://github.com/bevry/docpad) através do comando:\n\n\t\tsudo npm install -fg docpad@6.11\n\n3. Agora clone o projeto:\n\n\t\tgit clone git@github.com:braziljs/conf-boilerplate.git\n\n4. Depois vá para pasta do projeto:\n\n\t\tcd conf-boilerplate\n\n5. Instale as dependências:\n\n\t\tdocpad install\n\n6. E finalmente rode:\n\n\t\tdocpad run\n\nAgora você irá ver o site rodando em `localhost:9778` :D\n\n## Estrutura\n\nA estrutura básica do projeto se dá na seguinte forma:\n\n\u003cpre\u003e\n.\n|-- out/\n|-- src/\n|   |-- documents\n|   |-- files\n|   |-- layouts\n|   |-- partials\n|-- docpad.coffee\n|-- package.json\n`-- publish.sh\n\u003c/pre\u003e\n\n### out/\n\nÉ 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](https://github.com/braziljs/conf-boilerplate/blob/master/.gitignore)).\n\n### [src/documents](https://github.com/braziljs/conf-boilerplate/blob/master/src/documents)\n\nContém o arquivo responsável por importar todas as seções da aplicação.\n\n### [src/files](https://github.com/braziljs/conf-boilerplate/tree/master/src/files)\n\nPossui as imagens, arquivos CSS, JS e o [CNAME](https://github.com/braziljs/conf-boilerplate/blob/master/src/files/CNAME) que indica o domínio personalizado que deve ser usado *(mais informações sobre como usar seu domínio próprio em [Deploy](#dom%C3%ADnio-personalizado))*.\n\n### [src/layouts](https://github.com/braziljs/conf-boilerplate/tree/master/src/layouts)\n\nContém o template padrão da aplicação.\n\n### [src/partials](https://github.com/braziljs/conf-boilerplate/tree/master/src/partials)\n\nSão blocos de código utilizados para gerar a página principal do site ([index.html](https://github.com/braziljs/conf-boilerplate/blob/master/src/documents/index.html.eco)).\n\n### [docpad.coffee](https://github.com/braziljs/conf-boilerplate/blob/master/docpad.coffee)\n\nArmazena de forma fácil a maior parte das configurações da aplicação.\n\n### [package.json](https://github.com/braziljs/conf-boilerplate/blob/master/package.json)\n\nLista as dependências de módulos do NodeJS.\n\n### [publish.sh](https://github.com/braziljs/conf-boilerplate/blob/master/publish.sh)\n\nShell Script responsável pela publicação do site via [Github Pages](http://pages.github.com).\n\n## Customização\n\nO 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.\n\nDe qualquer forma, nós preparamos algo altamente customizável para você, portanto para maioria das alterações do projeto basta ir até o `docpad.coffee` e alterar o valor das variáveis.\n\n### Informações básicas sobre a conferência\n\nQuer alterar o nome, data, endereço, cidade ou preço do evento? É só mudar.\n\n```\nconf:\n\tname: \"Conference name\"\n\tdescription: \"Conference description\"\n\tdate: \"November 15\"\n\tprice: \"$100\"\n\taddress: \"Boulevard Kukulcan, 30, México\"\n\tvenue: \"Coco Bongo\"\n\tcity: \"Cancún\"\n```\n\n### Informações básicas sobre o site\n\nQuer mudar a imagem de capa, código do Google Analytics ou o favicon? Vá em frente!\n\n```\nsite:\n\turl: \"http://confboilerplate.com\"\n\tfavicon: \"http://braziljs.org/favicon.ico\"\n\tgoogleanalytics: \"UA-33656081-1\"\n\timages:\n\t\tcover: \"http://f.cl.ly/items/2X28422q1e3w0C2U1P3H/866591_24254643.jpg\"\n\t\tfacebook: \"http://braziljs.org/img/fb-share.jpg\"\n```\n\n### Seções ativas\n\nAinda não definiu a programação completa do evento? Não tem problema, basta alterar a variável `schedule` para `false`.\n\nAinda não sabe quem irá palestrar? Tudo bem, basta alterar a variável `speakers` para `false`.\n\nE por aí vai.\n\n```\nsections:\n\tabout: true\n\tlocation: true\n\tspeakers: true\n\tschedule: true\n\tsponsors: true\n\tpartners: true\n\tcontact: false\n```\n\n### Lista de Palestrantes\n\nPara incluir/alterar/excluir um palestrante também é igualmente simples, basta recorrer ao `schedule`.\n\n```\nschedule: [\n\tname: \"Chuck Norris\"\n\tphoto: \"http://f.cl.ly/items/2A3p1N0C3c0n3N3R1w2B/speaker.jpg\"\n\tbio: \"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\"\n\tcompany: \"Delta Command\"\n\ttwitter: \"littlechuck\"\n\tpresentation:\n\t\ttitle: \"How to kill a elephant with one finger\"\n\t\tdescription: \"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\"\n\t\ttime: \"13h00\"\n]\n```\n\nQuer listar mais algum atributo do palestrante que não está ali? Tudo bem, é só adicionar no `docpad.coffee` e depois exibí-lo com `\u003c%= speaker.seuNovoAtributo %\u003e` no [speakers.html.eco](https://github.com/braziljs/conf-boilerplate/blob/master/src/partials/section/speakers.html.eco).\n\n### Lista de outros itens da Agenda\n\nPara alterar os horários de check-in, almoço e coffee-break, é só recorrer as variáveis de `schedule`.\n\n```\nschedule: [\n\tname: \"Check-in / Breakfast\"\n\ttime: \"9h00\"\n]\n```\n\nMas 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.\n\n### Lista de Patrocinadores/Apoio\n\nPara adicionar qualquer patrocinador ou apoio no evento, é só recorrer as variáveis `sponsors` e `partners`.\n\n```\npartners: [\n\tname: \"BrazilJS\"\n\tlogo: \"http://f.cl.ly/items/2N3i2W0X2f3c2g2Z2N0f/Untitled-1.png\"\n\turl: \"http://braziljs.org\"\n]\n```\n\n## Deploy\n\nNós não gostamos de centralizar o poder de deploy em uma pessoa, portanto utilizaremos o recurso de [Github Pages](http://pages.github.com) que ainda é gratuito.\n\n* Dê permissão de execução para o script publish.sh - `chmod +x publish.sh`\n* Rode `sh publish.sh` na raíz do projeto.\n\nEspere alguns minutos até que o Github lhe envie um e-mail avisando que tudo ocorreu bem. Depois é só acessar: `http://seuUsuario.github.com/seuFork`\n\nOBS: Lembre-se de remover o arquivo `CNAME` que está na pasta `src/files` do seu projeto, caso você queira utilizar a URL pré-definida pelo Github.\n\n### Domínio personalizado\n\nCaso você não queira utilizar o domínio do Github, é possível usar seu próprio com alguns passos.\n\n1. Altere o arquivo `CNAME` que está na pasta `src/files` do seu projeto e preencha com o nome do seu domínio: `seuevento.com`. [Veja o exemplo](https://github.com/braziljs/conf-boilerplate/blob/master/src/files/CNAME).\n2. Altere o DNS do seu domínio seguindo as [instruções do Github](https://help.github.com/articles/setting-up-a-custom-domain-with-pages).\n\n### Como fazer sem Deploy utilizar Github Pages\n\nSe você prefere utilizar seu próprio servidor para hospedar o site:\n\n* Rode `docpad generate` na raíz do projeto.\n\nEsse comando irá gerar uma pasta `out` contendo apenas arquivos estáticos, depois é só fazer o upload do conteúdo dessa pasta para sua hospedagem.\n\n## Showcase\n\nConfira os eventos que usaram esse projeto como pontapé inicial:\n\n* [FrontInterior](http://frontinterior.com.br)\n* [Front in Maceió](http://frontinmaceio.com.br/)\n\nCriou um site usando o ConfBoilerplate? Nos avise =D\n\n## Quem está por trás disso?\n\nNó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.\n\n**Líder do Projeto**: [Zeno Rocha](http://github.com/zenorocha)\n\nAgradecimento especial a todos os membros da comunidade pelos feedbacks e contribuições.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcelod%2Fconf-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcelod%2Fconf-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcelod%2Fconf-boilerplate/lists"}