The goal of this project was to build a simple blog using Django, understand frontend development, and implement backend components such as API endpoints with the Django REST Framework.
I realized the importance of organizing project stages into different branches and commits. This not only facilitates collaboration but also allows for a clear retrospective analysis of the development process.
I became more mindful of handling credentials within the Git flow, emphasizing the importance of secure practices.
The project is not static. I have plans to further improve it:
Adding comprehensive unit tests to ensure the reliability of the codebase.
Preparing the project for deployment using Docker for seamless and scalable distribution.
If you want to run the project on your local machine you'll need to follow the setup instructions below.
-
Virtual environment tool
virtualenv.🔗 If you don't have already, make sure to install virtualenv.
-
Database: PostgreSQL
🔗 If you don't have already, make sure to install PostgreSQL version 15.4.
With this installation the Postgres GUI pgAdmin will be installed as well, unless you uncheck the box for pgAdmin during the installation process.
🔗 If you did so, you'll need to install pgAdmin separately.
The connector (database adapter) to connect your Django project with the database is already included in the requirements.txt file (see Step 3).
Use the following command:
git clone https://github.com/sasha-cz/blog-coding-green.git
Navigate to the project's root directory:
cd 'personal_website - Kopie'
First you will need to create a virtual environment for the project on your local machine.
🔗 Note: You can find the Python virtualenv docs here: https://virtualenv.pypa.io/en/latest/user_guide.html
Virtual Environment - Open a terminal and use the following command to create a virtual environment.
virtualenv env_name
This will create a folder in your current directory.
Activate the virtual environment.
On macOS/Linux (bash):
source env_name/bin/activate
On windows (bash):
.\env_name\Scripts\activate
You will know your virtual environment is active when your terminal displays the following:
(virtualenv) path\to\project\personal_website - Kopie
You just need to install the packages from the requirements.txt. To do this run in your activated environment:
pip install -r requirements.txt
Run migrations to set up the database:
python manage.py makemigrations
python manage.py migrate
To start the development server use the following command:
python manage.py runserver
Open your browser and navigate to the Homepage of the blog, located at http://127.0.0.1:8000/home/
The HTML templates and the style.css file within this project may include code snippets and templates provided by https://mdbootstrap.com/ (MDB Free) under the terms of the MIT license:
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The software is provided "As is", without warranty of any kind, express or implied, including but not limited To the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall The authors or copyright holders be liable for any claim, damages or other liability, whether in an action of Contract, tort or otherwise, arising from, out of or in connection with the software or the use or other Dealings in the software.