blango

A blog application based on Django.

Prerequisites

Checkout package.json and requirements.txt for current version of the packages below.

• Python
• Django
• Gunicorn
• Whitenoise
• TailwindCSS
• Autoprefixer
• PostCSS
• pnpm or npm or yarn

Installation and Usage

This is for installing and using in development. If you want to deploy it, see production.

• git clone https://github.com/bigyanse/blango.git
• cd blango
• pnpm install or npm install or yarn

If you use pipenv,

• pipenv install
• pipenv shell
• pnpm watch:style & pnpm dev

If you prefer, python's venv,

• python -m venv .env
• source .env/bin/activate.fish or choose one that fits your shell environment.
• python -m pip install -r requirements.txt
• pnpm watch:style & pnpm dev

Production

In case, if you want to deploy this blog application to production by tweaking this project, here is how you can go about it.

• Make sure you have all the prerequisites.
• After that, you can install all the required packages using python -m pip install -r requirements.txt.
• The db.sqlite3 database is only here for demo purpose. So, you may need to setup your own database. If you want to use sqlite as a database then you can just delete db.sqlite3 named file in the directory and proceed the steps below. Else, configure the database you want and also, follow the steps below.
• Run python manage.py migrate.
• Set DEBUG = False in core/settings.py.
• Set ALLOWED_HOSTS = ["*"] in core/settings.py or your desired value.
• Run pnpm build:style or npm run build:style or yarn build:style for tailwindcss.
• Run python manage.py collectstatic.
• Now you can deploy it using gunicorn core.wsgi.

Contributing

Your contribution would be highly appreciated. If you are new to open source, check out some guides.

Though it is highly susceptible to change, you can roughly follow this workflow for now:

1. Fork this repository on GitHub.
2. Clone your forked repository locally.
3. Check Installation and Usage for running it locally.
4. Make your changes and push it to your fork. Please follow good commit naming conventions or good branch naming conventions like feature/some-feature, bugfix/some-bug-fix.