practice-uffs / website-programa

Página web do programa PRACTICE
Apache License 2.0
9 stars 11 forks source link


Site do PRACTICE

Esse repositório contém o site do Programa de Ampliação e Consolidação de Tecnologias e Inovação no Contexto Educacional (PRACTICE) da Universidade Federal da Fronteira Sul, disponível em practice.uffs.cc

Link para o site oficial: https://practice.uffs.cc/

Dúvidas gerais: Envie um e-mail para practice@uffs.edu.br

Começando

Para testar o site localmente na sua máquina, você precisa ter algumas ferramentas instaladas que dependem do sistema operacional em uso. Siga os guias abaixo conforme o seu sistema operacional.

1. Windows

1.1 Pré-requisitos

Você precisa ter o git instalado e um editor de código qualquer, ex.: Visual Studio Code, disponíveis. Se você estiver usando Windows 10, é recomendado utilizar o Windows Subsystem for Linux para rodar o site.

IMPORTANTE: se você está no Windows 10, pule para a seção 2. Linux (Ubuntu) e siga as instruções dessa seção. Se estiver usando Windows 8, 7 ou inferior, continue lendo as seções abaixo.

1.1 Instale o Ruby

Instale a última versão do Ruby através do RubyInstaller. Baixe uma das versões Ruby+Devkit disponíveis, como o rubyinstaller-devkit-2.6.3-1-x64.exe, rode, e no último passo do instalador, escolha ridk install (para instalar gems com extensões nativas).

1.2 Instale o bundler

O site é construído com base no Jekyll que usa o bundler para gerenciar dependencias. Abra um terminal novo (para garantir que o PATH está atualizado depois de instalar o Ruby), e rode:

gem install bundler

2. Linux (Ubuntu)

2.1 Pré-requisitos

Você precisa ter o git e um editor de código qualquer, ex.: Visual Studio Code, disponíveis:

sudo apt install git

2.2 Instale o Ruby

Instale a última versão do Ruby:

sudo apt install ruby-full build-essential zlib1g-dev

A partir desse ponto, não é recomendado a utilização de uma conta root. Use a sua própria conta de usuário.

Primeiramente, configure o ambiente para a instalação do Ruby Gems:

echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc

Exporte o GEM_HOME:

echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc

Adicione o GEM_HOME ao PATH:

echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc

Carregue as novas configurações para o terminal:

source ~/.bashrc

2.3 Instale o bundler

O site é construído com base no Jekyll, que usa o bundler para gerenciar dependencias.

gem install bundler
sudo apt install ruby-bundler

Manuseio do site

Se você seguiu os pré-requisitos de instalação, a partir desse ponto você pode testar o site localmente na sua máquina. Siga os passos abaixo para

1. Faça fork do repositório

Faça fork do repositório do site pelo Github.

2. Clone esse repositório

Clone o seu fork em uma pasta qualquer da sua máquina, e.x: c:\ ou `/tmp/:

git clone https://github.com/SEU_USUARIO/website-programa.git && cd website-programa

Acessando o clone via terminal então instale todas as dependências:

cd src
bundle update

Antes de fazer qualquer alteração no site, lembre-se do Guia para a equipe de desenvolvimento.

3. Testando o site

Para testar o site, entre na pasta onde você clonou esse repositório, e rode:

bundle exec jekyll serve

Após alguns segundos, o site estará disponível através da URL http://127.0.0.1:4000. Depois de rodar o comando, você deve ver algo similar ao seguinte:

Configuration file: /mnt/c/website-programa/_config.yml
            Source: /mnt/c/website-programa
       Destination: /mnt/c/website-programa/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
                    done in 6.255 seconds.
                    Auto-regeneration may not work on some Windows versions.
                    Please see: https://github.com/Microsoft/BashOnWindows/issues/216
                    If it does not work, please upgrade Bash on Windows or run Jekyll with --no-watch.
 Auto-regeneration: enabled for '/mnt/c/website-programa'
    Server address: http://127.0.0.1:4000
  Server running... press ctrl-c to stop.

4. Deploy (produção)

Para colocar o site em produção, o conteúdo da pasta _site deve ser colocada em algum servidor web. Para gerar uma versão atualizada dela, rode o seguinte comando (dentro da pasta src do projeto).

bundle exec jekyll build

A partir daqui, o conteúdo da pasta _site está pronto para uso.

Licença

Esse projeto é licenciado nos termos da licença open-source Apache 2.0 e está disponível de graça.

Histórico de alterações

Todas as alterações importantes no site são relatadas no arquivo CHANGELOG.md.

Links importantes