https://github.com/reljicd/django-blog
Simple blog web app made using Django
https://github.com/reljicd/django-blog
bash blog bootstrap django django-admin django-orm django-templates django-testing docker python python3 sqlite3 unittest
Last synced: about 1 year ago
JSON representation
Simple blog web app made using Django
- Host: GitHub
- URL: https://github.com/reljicd/django-blog
- Owner: reljicd
- License: apache-2.0
- Created: 2017-12-09T15:14:53.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-04T22:04:10.000Z (over 3 years ago)
- Last Synced: 2025-03-26T10:36:31.756Z (about 1 year ago)
- Topics: bash, blog, bootstrap, django, django-admin, django-orm, django-templates, django-testing, docker, python, python3, sqlite3, unittest
- Language: Python
- Size: 43.9 KB
- Stars: 27
- Watchers: 3
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Blog Demo
## About
This is a demo project for practicing Django.
The idea was to build some basic blogging platform.
It was made using **Python 3.11** + **Django** and database is **SQLite**.
**Bootstrap** was used for styling.
Testing is done using **untitest** module.
There is a login and registration functionality included.
User has his own blog page, where he can add new blog posts.
Every authenticated user can comment on posts made by other users.
Home page is paginated list of all posts.
Non-authenticated users can see all blog posts, but cannot add new posts or comment.
App is covered with tests.
## Prerequisites
\[Optional\] Install virtual environment:
```bash
$ python -m virtualenv env
```
\[Optional\] Activate virtual environment:
On macOS and Linux:
```bash
$ source env/bin/activate
```
On Windows:
```bash
$ .\env\Scripts\activate
```
Install dependencies:
```bash
$ pip install -r requirements.txt
```
## How to run
### Default
You can run the application from the command line with manage.py.
Go to the root folder of the application.
Run migrations:
```bash
$ python manage.py migrate
```
Initialize data:
```bash
$ python manage.py loaddata users posts comments
```
Run server on port 8000:
```bash
$ python manage.py runserver 8000
```
#### Helper script
It is possible to run all of the above with helper script:
```bash
$ chmod +x scripts/run.sh
$ scripts/run.sh
```
### Docker
It is also possible to run the blog app using docker:
Build the Docker image:
```bash
$ docker build -t reljicd/django-blog -f docker/Dockerfile .
```
Run the Docker container:
```bash
$ docker run --rm -i -p 8000:8000 reljicd/django-blog
```
#### Helper script
It is possible to run all of the above with helper script:
```bash
$ chmod +x scripts/run_docker.sh
$ scripts/run_docker.sh
```
## Post Installation
Go to the web browser and visit `http://localhost:8000/blog`
Admin username: **admin**
Admin password: **adminpassword**
User username: **dusan**
User password: **dusanpassword**
## Helper Tools
### Django Admin
It is possible to add additional admin user who can login to the admin site. Run the following command:
```bash
$ python manage.py createsuperuser
```
Enter your desired username and press enter.
```bash
Username: admin_username
```
You will then be prompted for your desired email address:
```bash
Email address: admin@example.com
```
The final step is to enter your password. You will be asked to enter your password twice, the second time as a confirmation of the first.
```bash
Password: **********
Password (again): *********
Superuser created successfully.
```
Go to the web browser and visit `http://localhost:8000/admin`
### Tests
#### Default
Activate virtual environment:
On macOS and Linux:
```bash
$ source env/bin/activate
```
On Windows:
```bash
$ .\env\Scripts\activate
```
Running tests:
```bash
$ python manage.py test blog
```
#### Docker
It is also possible to run tests using Docker:
Build the Docker image:
```bash
$ docker build -t reljicd/django-blog -f docker/Dockerfile .
```
Run the Docker container:
```bash
$ docker run --rm reljicd/django-blog test blog
```