Skip to content

kencar17/SimpleBlog

Repository files navigation

GitHub release (latest by date) Black Pylint License

Simple Blog

Simple Blog made with Django

Features

Simple Blog provides the following features:

Authentication:

  • JWT Authentication

To-dos

Authentication:

  • JWT Authentication
  • Oauth Auth?
  • MFA (Text, Email, Authenticator App)

Account:

  • Account
  • User Management Endpoint
  • Password Reset Endpoint
  • Account Followers
  • Account Following

Blog:

  • Blog Management Endpoint
  • Tie Blog to User or Account
  • Categories
  • Tags

Comments:

  • Comments

Grammarly:

  • Grammarly Integration

ChatGPT/OpenAI:

  • Blog Assistant/Helper
  • Blog Catch Phrases
  • Blog Social Media Generator
  • Blog Categories & Tag Suggestions

Notifications:

  • Push Notifications
  • Email Notifications
  • Text Notification

Other:

  • Secret Key Generation
  • Search?

Getting Started

You can get started with Simple Blog immediately on the Kencar Cloud.

Alternatively you can set up a local development environment.

Environment Variables

  • BLOG_SECRET_KEY (random chars)
  • BLOG_SIGNING_KEY (random chars)
# Clone Report to local
git clone git@github.com:kencar17/SimpleBlog.git

# Create Virtual Environment or Environment of your choice
python -m venv venv

# Install Project Requirements
pip install -r requirements.txt

# Create BLOG_SECRET_KEY and BLOG_SIGNING_KEY. Make sure to copy theses as Environment Variables
# Optional param: --secret_key' - Specify length of key, defaults to 50
# Optional param: --signing_key' - Specify length of key, defaults to 50
python manage.py generate_secret_keys

# Make Migrations and Migrate Django Project
python manage.py makemigrations
python manage.py migrate

# Create Superuser
python manage.py createsuperuser

# Run Project
python manage.py runserver

In browser of your choice, navigate to http://localhost:8000/

Note: Please ensure all environment variables are configured

Contributing

Simple Blog is an open-source project. We are committed to a fully transparent development process and highly appreciate any contributions. Whether you are helping us fix bugs, proposing new features, improving our documentation or spreading the word - we would love to have you as a part of the Simple Blog community.

About

Simple Blog made with Django

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages