3.4
3.3
Esta seção descreverá como instalar a aplicação, contribuir com alterações e manter-se atualizado com as alterações mais recentes.
Este guia pressupõe que você saiba como executar um servidor local, trabalhar com controle de versão git e executar ferramentas a partir da linha de comando.
Os requisitos a seguir devem ser atendidos para executar o software nos repositórios do GitHub. Leia o Guia do Administrador se estiver instalando a partir de um pacote de versão.
Se você estiver usando o Windows, pode ser necessário instalar o GNU Patch e adicioná-lo à variável de ambiente PATH do seu sistema.
Fork e clone o OJS, OMP ou repositório OPS no GitHub. (Como fork e clonar um repositório no GitHub.)
No seu terminal, navegue até o diretório raiz da aplicação e execute o seguinte comando para verificar os submódulos:
git submodule update --init --recursive
Copie o arquivo de configuração padrão.
cp config.TEMPLATE.inc.php config.inc.php
Abra o arquivo config.inc.php, encontre as configurações do banco de dados e atualize-as para corresponder às credenciais do seu servidor SQL.
Instale dependências com o composer.
composer --working-dir=lib/pkp install
composer --working-dir=plugins/paymethod/paypal install
Execute o seguinte comando se estiver instalando o OJS.
composer --working-dir=plugins/generic/citationStyleLanguage install
Instale dependências com NPM.
npm install
npm run build
Execute o seguinte comando para iniciar o aplicativo usando o servidor interno do PHP.
php -S localhost:8000
Carregue seu navegador e navegue até http://localhost:8000 para instalar a aplicação.
Versões publicadas do software podem ser encontradas em branches no repositório git. Por exemplo, execute o seguinte comando check out da versão 3.3.0 do software.
git checkout stable-3_3_0
Para obter alterações na aplicação que foram feitas após a forked, adicione o remote upstream.
Para OJS:
git remote add upstream git@github.com:pkp/ojs.git
cd lib/pkp
git remote add upstream git@github.com:pkp/pkp-lib.git
cd ../ui-library
git remote add upstream git@github.com:pkp/ui-library.git
cd ../..
Para OMP:
git remote add upstream git@github.com:pkp/omp.git
cd lib/pkp
git remote add upstream git@github.com:pkp/pkp-lib.git
cd ../ui-library
git remote add upstream git@github.com:pkp/ui-library.git
cd ../..
Execute os comandos a seguir sempre que desejar fazer pull das alterações mais recentes em seu repositório.
# Atualize o app
git checkout main
git pull upstream main
git push
# Atualize o submódulo pkp-lib
cd lib/pkp
git checkout main
git pull upstream main
git push
# Atualize o submódolo ui-library
cd ../ui-library
git checkout main
git pull upstream main
git push
cd ../..
Quando você tiver retirado as alterações do remoto upstream, execute o seguinte para sincronizar os submódulos lib/pkp e lib/ui-library.
git submodule update --init --recursive
Pode ser necessário atualizar as dependências e reconstruir o pacote JavaScript.
composer --working-dir=lib/pkp update
npm install
npm run build
Às vezes, uma alteração de código modificará a estrutura do banco de dados e você precisará executar o script de atualização.
php tools/upgrade.php upgrade
Todas as contribuições devem ser escritas em um branch e enviadas para seu fork. Em seguida, abra uma Pull Request para o repositório do PKP.
Para código destinado a inclusão na base de código principal:
main para inclusão na próxima versão principal. As correções de bugs são melhor contribuídas para o branch estável mais recente (por exemplo, stable-3_3_0 para 3.3.0).Para contribuições que são distribuídas separadamente como patches ou plugins:
Agora que você está pronto, saiba mais sobre a arquitetura da aplicação.