Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eliflores/mignonnesaurus-blog
A blog written in Django and based on the Django Girls Tutorial Blog.
https://github.com/eliflores/mignonnesaurus-blog
community django djangogirls python tutorial
Last synced: 2 months ago
JSON representation
A blog written in Django and based on the Django Girls Tutorial Blog.
- Host: GitHub
- URL: https://github.com/eliflores/mignonnesaurus-blog
- Owner: eliflores
- License: cc-by-sa-4.0
- Created: 2015-05-16T06:10:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T19:17:32.000Z (8 months ago)
- Last Synced: 2024-05-22T20:02:30.810Z (8 months ago)
- Topics: community, django, djangogirls, python, tutorial
- Language: JavaScript
- Homepage:
- Size: 1.34 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mignonnesaurus Blog
[](https://circleci.com/gh/eliflores/mignonnesaurus-blog)
[](https://codeclimate.com/github/eliflores/mignonnesaurus-blog/test_coverage)
[](https://codeclimate.com/github/eliflores/mignonnesaurus-blog/maintainability)
[](https://creativecommons.org/licenses/by/4.0/)
[](https://conventionalcommits.org)
- [Introduction](#Introduction)
- [How to run the project locally?](#How-to-run-the-project-locally)
- [How to run tests?](#How-to-run-tests)
- [Test suite](#Test-suite)
- [Single test case(s)](#Single-test-cases)
- [Modify the verbosity level](#Modify-the-verbosity-level)
- [Code coverage](#Code-coverage)
- [Coverage report](#Coverage-report)
- [E2E Tests](#E2E-Tests)
- [On a local machine :computer:](#On-a-local-machine-computer)
- [Pre-requirements](#Pre-requirements)
- [Running E2E Tests](#Running-E2E-Tests)
- [On a remote machine :cloud:](#On-a-remote-machine-cloud)
- [Pre-requirements](#Pre-requirements-1)
- [Running E2E Tests](#Running-E2E-Tests-1)
- [Continuous Integration](#Continuous-Integration)
## Introduction
I :yellow_heart: the [Django Girls Tutorial](https://tutorial.djangogirls.org/en/). After [following it](https://github.com/mignonnesaurus/my-first-blog), I continued the fun by:
* Adding Tests
* Setting up Continuous Integration with [circleci](https://circleci.com/)
* Setting up [Code Climate](https://codeclimate.com/)
## Getting started
### How to run the project locally?
1. Install the version of Python the [.tool-versions](.tool-versions) file.
* You may want to use [asdf](https://asdf-vm.com/) for this purpose.
2. Make sure you have [GNU Make](https://www.gnu.org/software/make/) installed on your machine.
* A [Makefile](Makefile) was added to the project to simplify some tasks.
3. The project uses [pipenv](https://github.com/pypa/pipenv) to manage the Python dependencies and facilitate the
workflow when working with a virtualenv. You'll need to [install pipenv](https://github.com/pypa/pipenv#installation)
before getting started:
```bash
brew install pipenv
```
3. Setup dev environment:
```bash
make dev_setup
```
4. Make sure things are healthy by running the tests:
```bash
make test
```
5. Start the server:
```bash
make runserver
```
## How to run tests?
### Test suite
All the tests that are run as part of CI are in the [tests](tests) folder, and you can run them locally with:
```bash
python manage.py test tests
```
ℹ️ Additionally, you can run: `make test`
The execution includes _E2E_ Functional Tests that run on Firefox in headless mode.
_E2E_ / _UI_ tests that do not run in headless mode, can be run separately, see the [E2E Tests](#e2e-tests) section.
### Single test case(s)
You can pass the module or test case:
```bash
python manage.py test
```
For example, to run all the tests in the `test_models` module:
```bash
python manage.py test tests.test_models
```
And you can also use the `--pattern` or `-p` argument. For example:
```bash
python manage.py test --pattern="*_forms.py"
```
```bash
python manage.py test -p "*_forms.py"
```
### Modify the verbosity level
You can get more details about the test execution by passing the argument `--verbosity` or `-v`. For the value you can choose from: `0, 1, 2, 3`.
For example, to pass verbosity of 2:
```bash
python manage.py test tests -v 2
```
### Code coverage
```bash
coverage run manage.py test tests
```
#### Coverage report
```bash
coverage html -d coverage-report
```
### E2E Tests
:mag_right: It is also possible to run a single E2E test by using the options described [here](#single-test-cases).
### On a local machine :computer:
#### Running E2E Tests
E2E Tests that do not run in headless mode are currently run separately from the main [test suite](#how-to-run-tests)
and can be run with:
```bash
python manage.py test e2e.local
```
#### Troubleshooting E2E Tests
E2E tests by default run in _headless_ mode, this means that if you want to
troubleshoot via the browser and the driver doing its magic, you will need
to modify the test you would like to troubleshoot and change:
```python
firefox_options.headless = True
```
to
```python
firefox_options.headless = False
```
### On a remote machine :cloud:
Remote E2E Tests - tests that run _on the cloud_ - are setup to run on [Sauce Labs](https://saucelabs.com/) :zap:.
#### Pre-requirements
* A _username_ and _API Key_ is needed to run the tests on the Sauce Labs Testing Cloud.
#### Running E2E Tests
Tests that run on the cloud can be run with:
```bash
python manage.py test e2e.remote
```
### Demos
A visual demo of the blog, implemented with [SeleniumBase](https://pypi.org/project/seleniumbase/) can be run with:
```bash
sh demo.sh
```
ℹ️ Make sure that your development server is already started, before running the demo.
#### Pre-requirements
* Install [geckodriver](https://github.com/mozilla/geckodriver) - The [Web Driver](https://developer.mozilla.org/en-US/docs/Web/WebDriver) for Firefox.
## Continuous Integration
Continuous Integration (CI) is managed with the help of [CircleCI](https://app.circleci.com/pipelines/github/eliflores/mignonnesaurus-blog).
Every time a PR is opened all tests inside [tests](tests) are run. Passing tests are required to merge a PR to master.
---
[![CC BY-SA 4.0][cc-by-sa-shield]][cc-by-sa]
This work is licensed under a
[Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].
The tutorial that was followed for the creation of this blog is attributed to [Django Girls](https://djangogirls.org/) and it can be found [here](https://tutorial.djangogirls.org/).
[![CC BY-SA 4.0][cc-by-sa-image]][cc-by-sa]
[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/
[cc-by-sa-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png
[cc-by-sa-shield]: https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg