O banco colaborativo de bases de dados. Acesse aqui.
- [Jekyll][https://jekyllrb.com/] para geração de páginas estáticas
- [SCSS][https://sass-lang.com/] para estilos
- Instalação
- Indexando a busca no Algolia
- Colaborando com a bases de dados
- Créditos
- The MIT License (MIT)
Para que prefere utilizar Docker (evita a instalação do Ruby e do Jekyll na máquina), é necessário rodar apenas um comando que rapidamente o servidor de desenvolvimento estará disponível.
Pré-requisitos:
docker-compose up
Pré-requisitos:
Siga os formatos padrões de instalação.
Ao fim, não se esqueça de abrir o GitBash instalar o Bundler com o comando gem install jekyll bundler.
- Clone o repositório digitando
$ git clone https://github.com/colaboradados/colaboradados.github.io.gitno Gitbash. - Pela linha de comand, vá até a pasta onde você clonou o repositório em seu computador.
- Digite
$ bundle installe depois$ bundle exec jekyll serveno GitBash.
Caso não tenha dado nenhum erro, pule para a etapa 5. - Caso tenha dado erro na execução do jekyll, você provavelmente precisará instalar a Gem. Escreva
$ touch Gemfileno GitBash. Abra o arquivo Gemfile que você acabou de criar na pasta do seu projeto no editor de sua preferência. Escreva dentro do arquivosource "https://rubygems.org" gem "jekyll" gem "jekyll-gist"Se tudo deu certo, prossiga para a etapa 5. - Abra o seu navegador e digite
http://localhost:4000/. Se tudo deu certo você conseguirá ver o site rodando localmente em seu computador.
Pré-requisitos:
- Abra o terminal do Ubuntu e digite
$ sudo apt-get updatepara atualizar a lista de repositórios. - Depois de atualizar a lista de repositórios digite
$ sudo apt-get install ruby-full build-essential zlib1g-devpara instalar o Ruby e dependencias que são requeridas para rodar o projeto. - Após a instalação do Ruby, digite
$ gem install jekyll bundler - Instale tambem o Git, digite
$ sudo apt-get install git
- Clone o repositório digitando
$ git clone https://github.com/colaboradados/colaboradados.github.io.gitno Gitbash. - Vá até a pasta onde você clonou o repositório em seu computador.
- Digite
$ bundle installe depois$ bundle exec jekyll serveno Terminal. - Abra o seu navegador e digite
http://localhost:4000/. Se tudo der certo você conseguirá ver o site rodando localmente em seu computador.
A ser redigido
Para carregar o índice corretamente defina as variáveis abaixos no _config.yml:
algolia:
application_id: GVM6HECTJP
index_name: colaboradados
search_only_api_key: rvtp4mqkxaeqyf9d6wkj52xj9lahmjg4Depois execute o comando:
$ ALGOLIA_API_KEY='<password>' bundle exec jekyll algoliaO Colaboradados é uma iniciativa sem fins lucrativos e feita para comunidade e com a ajuda da mesma. Para ajudar com nossa base de dados você precisará seguir o caminho da pasta colaboradados.github.io/_posts e escolher o arquivo com o nome da base para a qual você quer colaborar. Os arquivos estão em Markdown e você poderá abrir no Visual Studio Code ou em seu ambiente de desenvolvimento preferido. Os arquivos precisam ser editados seguindo exatamente o mesmo padrão para listas e títulos. Isso deixará o trabalho organizado e facilitará para que o @colabora_bot, nosso bot do Twitter, consiga funcionar plenamente.
Se tiver dúvidas, entre em contato conosco.
Este projeto foi desenvolvido por Judite Cypreste, e contou com a grande colaboração de Jessica Temporal, João Ernane e Miriam Retka.
O site foi desenvolvido com design de HTML5 UP, com integração ao Jekyll de Andrew Banchich.
Copyright (c) 2019 Judite Cypreste
A permissão é concedida, gratuitamente, a qualquer pessoa que obtenha uma cópia deste software e dos arquivos de documentação associados (o "Software"), para lidar com o software sem restrições, incluindo, sem limitação, os direitos de uso, cópia, modificação, merge, publicar, distribuir, sublicenciar e / ou vender cópias do Software e permitir que as pessoas a quem o software é fornecido o façam, sob as seguintes condições:
A declaração de direitos autorais acima e esta permissão devem ser incluídos em todas as cópias ou partes substanciais do software.
O SOFTWARE É FORNECIDO "TAL COMO ESTÁ", SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU IMPLÍCITA, INCLUINDO MAS NÃO SE LIMITANDO A GARANTIAS DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UMA FINALIDADE ESPECÍFICA E NÃO INFRACÇÃO. EM NENHUM CASO OS AUTORES OU TITULARES DE DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER REIVINDICAÇÃO, DANOS OU OUTRA RESPONSABILIDADE, SEJA EM AÇÃO DE CONTRATO, TORT OU OUTRA FORMA, DECORRENTE DE, FORA DE OU RELACIONADO AO SOFTWARE OU O USO DE PROUTOS.
Copyright (c) 2019 Judite Cypreste
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.