Skip to content

Latest commit

 

History

History
121 lines (92 loc) · 3.74 KB

README.md

File metadata and controls

121 lines (92 loc) · 3.74 KB

Django-Hyperbeam

About

A collection of basic Django web applications that provides a solid foundation for those who are starting their journey in web development using Django. This collection includes various simple applications that help beginners understand the core concepts of Django and how to build web applications with this framework.

Basic applications ie., Blog, Poll outlined in the Django documentation.


Applications

  • Blog
  • Polls
  • Feedbacks/Contact Us
  • Custom user profile
  • ChatGPT
  • Password Generator

Prerequisites


Installation

  1. Clone reporsitory.
$ git clone https://github.com/kitimi88/dj-hyperbeam.git
  1. Setup virtual environment.
$ py -m venv .venv
$ .venv\scripts\activate
  1. Upgrade pip (Whenever necessary).
$ py -m pip install --upgrade pip
  1. Install required dependecies.
$ py -m pip install -r requirements.txt
  1. Setup database and apply migration.
$ py manage.py makemigrations
$ py manage.py migrate
  1. Start development server.
$ py manage.py runserver

IMPORTANT - Your preferred configuration should be defined in the env.example.txt and save it as .env in your main directory. Should you need a new SECRET_KEY, run the following:

$ py sskey_gen.py

Note

This application may require the following packages:

Package Description
python-dotenv Read key-value pairs from .env file and set them as environment variables. In this sample app, those variables describe how to connect API. This package is used in the applications to load environment variables.
OpenAI API Chatbot application requires integrating with an external API for natural language processing.
django-environ Allowing users use Twelve-factor methodology to configure your Django application with environment variables.
Bootstrap For fast and simple yet powerful web design.

References and documentations


Screenshots

Indexpage Blogpost Chatbot user_profile_page poll_list poll_detail password_gen

Contributions

Pending contribution guide.


License

MIT License


Check out my other respository for more python projects.