Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bedjango/bedjango-starter

An easy to use project template for Django 1.11
https://github.com/bedjango/bedjango-starter

django django-application

Last synced: about 1 month ago
JSON representation

An easy to use project template for Django 1.11

Host: GitHub
URL: https://github.com/bedjango/bedjango-starter
Owner: BeDjango
License: mit
Created: 2017-02-17T09:37:21.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2018-02-18T20:54:49.000Z (over 6 years ago)
Last Synced: 2024-09-28T16:23:43.699Z (about 2 months ago)
Topics: django, django-application
Language: CSS
Homepage: http://www.bedjango.com
Size: 18.9 MB
Stars: 49
Watchers: 14
Forks: 13
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# BeDjango starter skeleton ![](http://www.bedjango.com/static/images/logo-bedjango.svg)

An easy to use project template for Django 1.11, for more information visit our [blog](http://www.bedjango.com/blog/create-django-application-bedjango-starter/)

[![Build Status](https://api.travis-ci.org/BeDjango/bedjango-starter.svg?branch=master)](https://travis-ci.org/BeDjango/bedjango-starter)
[![Coverage Status](https://coveralls.io/repos/github/BeDjango/bedjango-starter/badge.svg)](https://coveralls.io/github/BeDjango/bedjango-starter)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/146d6b54a28b4ca19770c5984c93eab1)](https://www.codacy.com/app/pabloig90/bedjango-starter?utm_source=github.com&utm_medium=referral&utm_content=BeDjango/bedjango-starter&utm_campaign=Badge_Grade)

## Features
- High code coverage
- Custom theme and responsive based on bootstrap
- Usefull packages
- Default views
- User control system
- Modularity of the applications
- Application ready for intenationalization
- Python2/3 compatibility
- Different utils (Decorators, breadcrumbs..)
- PO files web editor provided by django-rosetta
- Cookies adapted to EU Commision standards.

## Prerequisites
What things you need to use this starter and how to install them:
- Git (if you are going to clone this project):

```sh
sudo apt install git
```
- Pip:

```sh
sudo apt install python-pip
```

- Virtualenv:

```sh
sudo pip install virtualenv
```

- Python3-dev:

```sh
sudo apt install python3-dev
```

## How to use it

The following steps have been created based on a ubuntu 16 using python3.5. To create a new application using this starter, you must do the following steps

# Create virtualenv
virtualenv -p python3 venv

# Activate virtualenv and install Django
source venv/bin/activate
pip install django==1.11

Use django-admin to create the app using the starter
django-admin.py startproject --template=https://github.com/BeDjango/bedjango-starter/archive/master.zip --extension=py,rst,yml {{nameofproject}}

# Install requirements/dev-requirements
cd nameofproject/nameofproject
pip install -r requirements.txt
pip install -r requirements-dev.txt

# Migrate database
python3 manage.py migrate

# Compile translations
python3 manage.py compilemessages

# To run our project:
python3 manage.py runserver

Now your app is running at [localhost](http://localhost:8000)

## Other commands


# Create superuser (Password must be at least 8 characters and contain letters, numbers and special characters !-·$%/()=?)

python3 manage.py createsuperuser

# You can create a project from a local template

git clone https://github.com/bedjango/bedjango-starter.git

django-admin.py startproject --template=bedjango-starter/project_name --extension=py,rst,yml {{nameofproject}}

# If we need to create a new app inside our project, we must clone this repo and run following command:

django-admin.py startapp --template=bedjango-starter/project_name/project_name --extension=py,rst,yml {{nameofapp}}

## Testing

To run tests we must run the following command:
```sh
coverage run --source='.' manage.py test --settings base.test_settings

# To get a coverage report
coverage report -m

```

## Packages included

- [Django debug toolbar](http://django-debug-toolbar.readthedocs.io/en/stable/)
- [Django cachalot](http://django-cachalot.readthedocs.io/en/latest/)
- [Material design for admin](http://forms.viewflow.io/)
- [Django-rosetta (PO files web editor)](https://django-rosetta.readthedocs.io/en/latest/)
- [Django Cookie law](https://github.com/TyMaszWeb/django-cookie-law)

## License

This project is licensed under the MIT License