Skip to content

Latest commit

 

History

History
129 lines (88 loc) · 3.4 KB

README.md

File metadata and controls

129 lines (88 loc) · 3.4 KB
Raw

Bloggy

Introducing Bloggy! The Open-Source Blogging Platform for developers. It is Built on Python and Django framework and powers stacktips.com blog.

If you are a new contributor to this project, have a look out for issues that have the Hacktoberfest label.

Key Features

Along with tons of features aimed at enhancing the development and blogging experience.

  • Signup and Login: Seamlessly create your account and log in to access exclusive content.
  • Magic Link Sign-In: Forget passwords! We've streamlined the login process with magic link sign-in.
  • Create and Publish: Share your knowledge with the world by creating and publishing articles, courses, and quizzes effortlessly.
  • Customized Admin Dashboard: Manage your content efficiently with a user-friendly admin dashboard designed with you in mind.
  • Sitemaps: Enhance discoverability with built-in sitemaps that improve search engine ranking.
  • Webmaster Notifications: Get noticed! StackTips automates Google and Bing webmaster notifications to ensure your content reaches a wider audience.

Get Involved!

Are you a developer looking to enhance your skills, share your knowledge, or simply be curious about the inner workings of a developer-centric blog platform? Now's your chance!

Want to contribute right away?

Check out the issues section. https://github.com/StackTipsLab/bloggy/issues

Installation Guide

Checkout the code from our git repository

git clone [email protected]:StackTipsLab/bloggy.git

Create a virtual env

python3 -m venv .venv
source .venv/bin/activate

Install python dependencies

pip3 install -r requirements.txt

Rename the .env.example file to .env and provide all the configuration details including Database, and Email Configurations. Bare minimum, you will need these properties to get started.

SECRET_KEY=
DEBUG=True
ALLOWED_HOSTS=127.0.0.1,localhost

# Your database configuration details
DB_NAME=bloggy
DB_USER=root
DB_PASSWORD=password
DB_HOST=127.0.0.1
DB_PORT=3306

Create and apply database migrations

python3 manage.py makemigrations
python3 manage.py migrate

Create superuser

python3 manage.py createsuperuser

Collect static files before publishing or development.

python3 manage.py collectstatic

Start the application

python3 manage.py runserver

Bloggy Frontend Module

For building frontend code, you will need the following node version.

node -v
  v12.22.12
  
npm -v      
  6.14.16

Once you have the above node version installed, install node dependencies using the following command.

npm install

Now, you can build

npm run start
npm run build # to generate a production build

Importing Demo Content

We currently supports importing the categories from CSV file. This can be done using the runseed command. All you need to do is to provide the base path where your .csv files are located.

The sample CSV files are located in bloggy/demo_content directory.

python3 manage.py runseed --dir=demo_content