Skip to content

Commit 2241edb

Browse files
committed
docs: add detailed project description and setup instructions
1 parent ae88046 commit 2241edb

File tree

1 file changed

+86
-4
lines changed

1 file changed

+86
-4
lines changed

README.md

Lines changed: 86 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,91 @@
11
# IndianDefence
22

3-
A basic Django website showcasing weapons of Indian military.
4-
5-
[![Live Demo](https://img.shields.io/badge/Live-Demo-brightgreen)](https://indian-defence.vercel.app/)
3+
> A basic Django website showcasing weapons and equipments of Indian military.
64
75
## The Project
6+
> Explore the project live at: [![Live Demo](https://img.shields.io/badge/Live-Demo-brightgreen)](https://indian-defence.vercel.app/)
7+
8+
![](https://github.com/Rahullkumr/IndianDefence/blob/main/ID.gif)
9+
10+
## 📌 Features
11+
12+
- Categorized display of Indian military assets:
13+
- **Land**: Tanks, artillery, and other ground equipment.
14+
- **Air**: Fighter jets, helicopters, and other aerial assets.
15+
- **Water**: Naval ships, submarines, and other maritime equipment.
16+
- Simple and intuitive user interface for easy navigation.
17+
18+
## 🛠️ Tech Stack
19+
20+
- **Backend**: Django (Python)
21+
- **Frontend**: HTML, CSS, JavaScript
22+
- **Deployment**: Vercel
23+
24+
## 🚀 Getting Started
25+
26+
### Prerequisites
27+
28+
- Python 3.x
29+
- pip (Python package installer)
30+
31+
### Installation
32+
33+
1. **Clone the repository:**
34+
35+
```bash
36+
git clone https://github.com/Rahullkumr/IndianDefence.git
37+
cd IndianDefence
38+
```
39+
40+
2. **Create a virtual environment:**
41+
42+
```bash
43+
python -m venv env
44+
source env/bin/activate # On Windows: env\Scripts\activate
45+
```
46+
47+
3. **Install the dependencies:**
48+
49+
```bash
50+
pip install -r requirements.txt
51+
```
52+
53+
4. **Apply migrations:**
54+
55+
```bash
56+
python manage.py migrate
57+
```
58+
59+
5. **Run the development server:**
60+
61+
```bash
62+
python manage.py runserver
63+
```
64+
65+
6. **Access the application:**
66+
67+
Open your browser and navigate to `http://127.0.0.1:8000/`
68+
69+
## 📁 Project Structure
70+
71+
```
72+
IndianDefence/
73+
├── air/ # Django app for air force assets
74+
├── land/ # Django app for land force assets
75+
├── water/ # Django app for naval assets
76+
├── base/ # Base templates and static files
77+
├── dev_static/ # Development static files
78+
├── manage.py # Django management script
79+
├── requirements.txt # Python dependencies
80+
├── vercel.json # Vercel deployment configuration
81+
└── ID.gif # Project-related media
82+
```
83+
84+
## 📄 License
85+
86+
This project is licensed under the [MIT License](LICENSE).
87+
88+
## 🙋‍♂️ Author
889

9-
![](https://github.com/Rahullkumr/IndianDefence/blob/main/ID.gif)
90+
- **Rahul Kumar**
91+
GitHub: [@Rahullkumr](https://github.com/Rahullkumr)

0 commit comments

Comments
 (0)