Skip to content

partiu/api-docs

 
 

Repository files navigation

Partiu API! Docs

Build Status NPM version

Dependency Status devDependency Status

Este repositório é usado para gerar e publicar a interface web da Partiu API.

URL pública temporária: https://partiuvantagens.github.io/api-docs/dist

Vagrant

Inicie a máquina virtual:

vagrant up

Efetue o acesso via SSH:

vagrant ssh

Dentro da márquina virtual, o diretório /vagrant contém os dados do projeto api-docs:

cd /vagrant

Para desligar a máquina virtual, utilize o comando abaixo:

vagrant halt

Desenvolvimento

Todas as alterações devem ser realizadas no diretório src e compiladas com o comando build:

npm run-script build

As páginas e assets serão gerados no diretório dist do projeto e deverão ser enviadas ao controle de versão.

Você poderá editar os arquivos do projeto em sua própria máquina (host), porém o comando build deverá ser executado dentro da máquina virtual.

Deploy

Estratégia para deploy de um subdiretório no GitHub Pages (ver http://yeoman.io/learning/deployment.html)

git subtree push --prefix dist origin gh-pages
git push

About

Partiu API! - Swagger UI

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • JavaScript 88.3%
  • CSS 10.6%
  • HTML 1.1%