pycon.tw
pycon.tw copied to clipboard
PyCon TW Proposal System & Backend Server
PyCon TW
This repository serves the website of PyCon TW, Python Conference Taiwan. This project is open source and the license can be found in LICENSE.
Getting Started
Requirements
- Git 1.8+
- Python 3.6.x
- Yarn 1.0+
- Node.js 8.0+
Set up a Development Environment & Run Server
Method 1 : Quick Start
- Run with docker-compose & shell scripts
Method 2 : Step by step
- Launch on your local runtime
Run Tests
Tests are managed with pytest-django. You have two options to run tests, either with the local environment, or in an isolated one via Tox.
Testing in the Local Environment
Run the following command inside src:
pytest
To run tests with coverage report:
pytest --cov=.
Testing with Tox
Run the following inside the top-level directory (the one with tox.ini):
tox
How to Contribute
Follow the GitHub Flow, please DO NOT push the commits into master directly. Always create branch by the feature you want to update. You are encouraged to submit a pull request for reviewing before merging things into master.
We strongly recommend you configure your editor to match our coding styles. You can do this manually, or use an EditorConfig plugin if your editor supports it. An .editorconfig file has already been attached to the repository.
Deployment
For site administrators, please refer to document/deploy_docker_prod.md.