Skip to content

Commit a4493ea

Browse files
author
tamaraiselvan
committed
Changes on Readme file and added requirments.txt
1 parent 17909df commit a4493ea

File tree

2 files changed

+73
-2
lines changed

2 files changed

+73
-2
lines changed

README.md

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
1-
# Base-django-project-Setup
2-
This is the basic setup of a Django project. Which contains the basic features of a Website.
1+
# Djnago Basic Setup Project
2+
3+
![PyPI - License](https://img.shields.io/pypi/l/Django?color=success&label=License%20Info)
4+
![GitHub repo size](https://img.shields.io/github/repo-size/tamaraiselvan/Base-django-project-Setup?label=Source%20code%20Size)
5+
6+
## Table of contents
7+
* [General info](#general-info)
8+
* [Technologies](#technologies)
9+
* [Features](#Features)
10+
* [Setup](#setup)
11+
12+
## General info
13+
This Repository have the basic setup of a Django Project. Since setting and configuring a basic setup of a project by using Django is difficult. You can clone this repository for your project and you can use it for your projects.
14+
15+
16+
## Technologies
17+
Project is created with:
18+
* Bootstrap 4
19+
* Python 3.10
20+
* Jazzmin 2.5
21+
* Django 4.0
22+
23+
### Features
24+
1> Authentication, Authorization
25+
2> Overwritten Django admin module
26+
3> Login and Sign up
27+
4> A basic page and basic Navigation system.
28+
5> A good and Mobile friendly User Interface.
29+
30+
## Setup
31+
32+
Follow these steps to make project run locally
33+
34+
1. Clone the repository
35+
```sh
36+
git clone https://github.com/The-Code-of-Duty-Team/Examination-project.git
37+
```
38+
2. Create a virtual environment
39+
```sh
40+
python -m venv virtualenviron_name
41+
```
42+
3. Activate the environment
43+
```sh
44+
virtualenviron_name\Scripts\activate
45+
```
46+
4. Install Requirements from the Requirements.txt file
47+
```sh
48+
pip install -r requirements.txt
49+
```
50+
5. Once you installed the requirements migrate the datebase
51+
```sh
52+
python manage.py migrate
53+
```
54+
6. Once after migrating, Create a superuser account
55+
```sh
56+
python manage.py createsuperuser
57+
```
58+
7. Run the server locally on your system
59+
```sh
60+
python manage.py runserver
61+
```
62+
8. Open your browser and type
63+
```sh
64+
http://127.0.0.1:8000/
65+
```
66+
67+
## Conclusion

requirements.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
asgiref==3.5.2
2+
Django==4.0.4
3+
django-crispy-forms==1.14.0
4+
django-jazzmin==2.5.0
5+
sqlparse==0.4.2
6+
tzdata==2022.1

0 commit comments

Comments
 (0)