Metadata-Version: 2.4
Name: django-hstl
Version: 0.2
Summary: A Hostel Mannagement WEB APP
Author: Shivam Singh
License-Expression: MIT
Project-URL: Homepage, https://github.com/dev-ShivamSingh-Github/hstl/
Project-URL: Sample, https://shivamsingh.pythonanywhere.com/
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django
Dynamic: license-file

## Hostel Management WebApp using django

### Pre-requisite: ``git, python``

## Quick start
1. Install app.
	```bash
	pip install django-hstl
	```
1. Modify settings.py such that
	```python
	AUTH_USER_MODEL = 'django_hstl.MyUser'
	
	# Add the app in your INSTALLED_APPS
	
	INSTALLED_APPS = [
		# ...,
		"django_hstl",
	]
	```
1. Include the app URLconf in your project urls.py like this
	```python
	path("hstl/", include("django_hstl.urls")),
	```
1. Run `python manage.py migrate` to create the models.
1. Create Superuser `manage.py createsuperuser`
1. Visit the `/hstl/` URL to explore the WEB APP.

## Getting Started
1. Create a directory and cd into it.
	```bash
	mkdir ./hstl/
	cd ./hstl
	```
1. Create a virtual environment and activate it.
	* LINUX / MAC
	```bash
	python3 -m venv .venv
	source ./.venv/bin/activate
	```
	* WINDOWS
	```bash
	python -m venv .venv
	.\.venv\Scripts\activate
	```
1. Install app.
	```bash
	pip install django-hstl
	```
1. Create a django project
	```bash
	django-admin startproject MyApp .
	```
1. Modify "MyApp/setting.py" such that
	```python
	AUTH_USER_MODEL = 'django_hstl.MyUser'
	
	# Add the app in your INSTALLED_APPS
	
	INSTALLED_APPS = [
		# ...,
		"django_hstl",
	]
	```
1. Include the app URLconf in "MyApp/urls.py" like this
    ```python
	path("hstl/", include("django_hstl.urls")),
	```
1. Run `python manage.py migrate` to create the models.
1. Create Superuser `manage.py createsuperuser`
1. Visit the `/hstl/` URL to explore the WEB APP.
