manegrao / cc.uffs.edu.br

Estrutura front-end do site oficial do curso de Ciência da Computação da Universidade Federal da Fronteira Sul, Chapecó/SC.

Site do curso de Ciência da Computação (UFFS)

Esse repositório contém o site do curso de Ciência da Computação da Universidade Federal da Fronteira Sul, disponível em cc.uffs.edu.br. O site não é patrimônio do curso, é da sua comunidade de alunos, professores e TAEs. Sinta-se convidado(a) a contribuir com o melhoramento desse site, sua ajuda é mais que bem-vinda!

Link para o site oficial: https://cc.uffs.edu.br

Dúvidas gerais: fale com os professores do curso, ou com os coordenadores Fernando Bevilacqua [Github, e-mail] e Luciano Caimi [email], ou através do e-mail da Coordenação do Curso ([email protected]).

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 (atualize isso agora, por favor!), 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 Jekyll

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

gem install jekyll -v 3.8.6

depois:

gem install bundler

Se tudo correr bem, você deve conseguir rodar o comando abaixo para checar a versão do Jekyll instalada:

jekyll -v

Você deve ver jekyll 3.8.6 como saída. Para o site funcionar corretamente, ele precisa de alguns plugins do Jekyll. Rode o seguinte para instalá-los:

gem install jekyll-sitemap jekyll-gist

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-get install git code

2.2 Instale o Ruby

Instale a última versão do Ruby:

sudo apt-get 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 Jekyll

O site é construído com base no Jekyll.

Rode:

gem install jekyll -v 3.8.6

depois:

gem install bundler

Se tudo correr bem, você deve conseguir rodar o comando abaixo para checar a versão do Jekyll instalada:

jekyll -v

Você deve ver jekyll 3.8.6 como saída. Para o site funcionar corretamente, ele precisa de alguns plugins do Jekyll. Rode o seguinte para instalá-los:

gem install jekyll-sitemap jekyll-gist

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. Clone esse repositório

Close esse repositório em uma pasta qualquer da sua máquina, e.x: c:\ ou `/tmp/:

git clone https://github.com/ccuffs/cc.uffs.edu.br cc.uffs.edu.br && cd cc.uffs.edu.br

2. Testando o site

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

jekyll serve

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

Configuration file: /mnt/c/cc.uffs.edu.br/_config.yml
            Source: /mnt/c/cc.uffs.edu.br
       Destination: /mnt/c/cc.uffs.edu.br/_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/cc.uffs.edu.br'
    Server address: http://127.0.0.1:4000
  Server running... press ctrl-c to stop.

3. Fazendo alterações

Você pode alterar qualquer um dos arquivos do site enquanto o jekyll estiver rodando. Ele vai detectar que arquivos foram modificados e automaticamente atualizará o conteúdo servido na URL http://127.0.0.1:4000.

Se você estiver fazendo alterações no site, é recomendado que tenha as Ferramentas de Desenvolvimento Web do seu navegador ativas enquanto você navega http://127.0.0.1:4000. Para fazer isso, basta abrir essa URL e pressionar F12.

4. Enviando suas alterações para o site oficial do curso (opcional)

Veja o arquivo CONTRIBUTING.md para saber como contribuir conteúdo ou alterações para o site oficial do curso.

Licença

O código-fonte desse site está disponível através da licença MIT. O seu conteúdo, como textos e imagens, são licenciadas como CC BY 4.0.

Contribuindo com o site

Sua ajuda é muito bem-vinda! Sinta-se convidado(a) a corrigir problemas no site, alterar conteúdos imprecisos, ou adicionar novos conteúdos como notícias e páginas. Siga as instruções do arquivo CONTRIBUTING.md para saber como contribuir.

Histórico de alterações

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

Links importantes

• Página oficial do curso de Ciência da Computação
• Página institucional do curso de Ciência da Computação
• Site da Universidade Federal da Fronteira Sul