https://github.com/nmfzone/django-boilerplate
Simple Django Boilerplate for building awesome web applications.
https://github.com/nmfzone/django-boilerplate
boilerplate django django-application django-boilerplate django-starter
Last synced: 10 months ago
JSON representation
Simple Django Boilerplate for building awesome web applications.
- Host: GitHub
- URL: https://github.com/nmfzone/django-boilerplate
- Owner: nmfzone
- Created: 2017-03-11T09:29:33.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-14T21:06:02.000Z (almost 9 years ago)
- Last Synced: 2024-12-30T04:32:47.750Z (12 months ago)
- Topics: boilerplate, django, django-application, django-boilerplate, django-starter
- Language: Python
- Homepage:
- Size: 1.15 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Django Boilerplate
Simple Django Boilerplate for building awesome web applications.
## Features
- Bootstrap 3, for styling the interfaces
- Laravel Mix, for bundling static assets through Webpack
## Requirements
- Python >= 3.5x, for Python 2 support, use 1.0 branch
- Pip
- Mysql
- NodeJs (Optional)
- Yarn (Optional)
- Virtualenv (Optional)
- Pyenv (Optional)
## How to use
1. Download or clone this repository `git clone git@github.com:nmfzone/django-boilerplate.git`
2. Install the provided packages `pip install -r requirements/main.txt` on OSX and Linux
or `pip install -r requirements/windows.txt` on Windows
3. Duplicate `.env.example` to `.env`
4. Provide the appropriate value in the `.env`
5. Migrate the database schema `python manage.py migrate`
6. Create the administrator `python manage.py createsuperuser`
7. Start the server `python manage.py runserver`
8. Open `http://localhost:8000` in your browser
9. Let's rock!
## Additional
- If you want to make the app work with some **Deep Learning** tools, you may install it with this command `pip install -r requirements/deep-learning.txt`
## Contributing
Want to contribute? Awesome. Just send a pull request.
## Bugs
If you discover a bug within this Boilerplate, please send an e-mail to Nabil Muhammad Firdaus at 123.nabil.dev@gmail.com.
## License
This Boilerplate is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).