Aviso
Esta versão do repo Torchbox.com agora está aposentada. Você provavelmente deseja https://github.com/torchbox/torchbox.com.
O conteúdo antigo de Reame é preservado abaixo para referência.
* * * * * * * * * *
Este é o site principal do Torchbox.com. A seção de carreiras deste site pode ser encontrada no Torchbox/Careers.
Este projeto contém documentação técnica escrita em Markdown na pasta /docs . Isso cobre, entre outros:
Você pode visualizá -lo usando mkdocs executando:
mkdocs serveA documentação estará disponível em: http: // localhost: 8001/
Este repositório inclui a configuração docker-compose para executar o projeto em contêineres locais do Docker e um Fabfile para provisionar e gerenciar isso.
Existem vários outros comandos para ajudar no desenvolvimento usando o script de tecido. Para ver todos eles, corra:
fab -lOs seguintes são necessários para executar o ambiente local. As versões mínimas especificadas estão funcionando: se você já tiver versões mais antigas instaladas, elas podem funcionar, mas não têm garantia de fazê -lo.
Observe que no Mac OS, se você tiver uma versão mais antiga do Fabric instalado, pode ser necessário desinstalar o antigo e instalar a nova versão com PIP3:
pip uninstall fabric
pip3 install fabric Você pode gerenciar diferentes versões do Python configurando pyenv : https://realpython.com/intro-to-pyenv/
Além disso, para interagir com ambientes de produção / estadiamento, você precisará:
Se você estiver usando o Docker Desktop, verifique se os recursos: as configurações de compartilhamento de arquivos permitem que o diretório clonado seja montado no contêiner da web (evitando falhas de tempo de execução da OCI mounting no final da etapa de construção).
Iniciar uma construção local pode ser feita em execução:
git clone [email protected]:torchbox/wagtail-torchbox.git
cd wagtail-torchbox
fab build
fab migrate
fab start Isso iniciará os contêineres em segundo plano, mas não o Django. Para fazer isso, conecte -se ao contêiner da Web com fab sh e Run honcho start a iniciar o Django e o Webpack Dev Server em primeiro plano.
Em seguida, conecte -se ao contêiner em execução novamente ( fab sh ) e:
dj createcachetable
dj createsuperuserO site deve estar disponível na máquina host em: http://127.0.0.1:8000/
Se você deseja executar apenas as ferramentas de front -end ou back -end, as execuções honcho com comandos estão no docker/Procfile .
Ao iniciar primeiro o contêiner, os arquivos estáticos podem não existir ou podem estar desatualizados. Para resolver isso, basta executar npm run build .
Aqui estão os comandos comuns:
# Install front-end dependencies.
npm install
# Start the Webpack build in watch mode, without live-reload.
npm run start
# Start the Webpack server build on port 3000 only with live-reload.
npm run build
# Do a one-off Webpack production build.
npm run build:prodExistem duas maneiras de executar as ferramentas de front -end:
.env na raiz do projeto (consulte .env.example ) com FRONTEND=local . fab start não iniciará mais um recipiente frontend . Agora, ao executar fab start , o Docker não tentará vincular -se às portas necessárias para o servidor de dev frontend, o que significa que elas podem ser executadas localmente. Todas as ferramentas ainda permanecem disponíveis no contêiner. Os pacotes Python podem ser instalados usando poetry no contêiner da web:
fab sh
poetry add wagtail-guide
Para redefinir as dependências instaladas de volta a como elas estão no arquivo poetry.lock :
fab sh
poetry install --no-root
Para implantar, mescle seu ramo de recursos para master ou staging ramificação. Depois que os pipelines do CI passarem, ele será implantado no respectivo site Heroku automaticamente.
Isso é feito através da integração do Heroku Github.