|
1 |
| -# Djnago Basic Setup Project |
| 1 | +# Django Basic Setup Project |
2 | 2 |
|
3 |
| - |
4 |
| - |
| 3 | + |
5 | 4 |
|
6 | 5 | ## Table of contents
|
7 | 6 | * [General info](#general-info)
|
8 | 7 | * [Technologies](#technologies)
|
9 |
| -* [Features](#Features) |
| 8 | +* [Features](#features) |
10 | 9 | * [Setup](#setup)
|
| 10 | +* [License](#license) |
11 | 11 |
|
12 | 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. |
| 13 | +This Repository has 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. This Repository is developed with a simplified coding style and file structure. |
14 | 14 |
|
15 | 15 |
|
16 | 16 | ## Technologies
|
17 | 17 | Project is created with:
|
18 |
| -* Bootstrap 4 |
| 18 | +* Bootstrap 5.3 |
19 | 19 | * Python 3.10
|
20 |
| -* Jazzmin 2.5 |
21 |
| -* Django 4.0 |
| 20 | +* Django 4.0.4 |
22 | 21 |
|
23 |
| -### Features |
24 |
| -1. Authentication, Authorization <br> |
25 |
| -2. Overwritten Django admin module <br> |
| 22 | +## Features |
| 23 | +1. Authentication, Authorization. <br> |
| 24 | +2. Overwritten Django admin module. <br> |
26 | 25 | 3. Login and Sign up and Logout.<br>
|
27 | 26 | 4. A Dashboard and Advanced Navigation system.<br>
|
28 | 27 | 5. A good and Mobile friendly User Interface.<br>
|
29 |
| -6. Advanced UI and UX. |
| 28 | +6. Advanced UI and UX.<br> |
| 29 | +7. Theme Customizer.<br> |
30 | 30 |
|
31 | 31 | ## Setup
|
32 | 32 |
|
33 |
| -Follow these steps to make project run locally |
| 33 | +Follow these steps to make the project run locally: |
34 | 34 |
|
35 |
| -1. Clone the repository |
| 35 | +1. Clone the repository. |
36 | 36 | ```sh
|
37 |
| - git clone https://github.com/tamaraiselvan/Base-django-project-Setup |
| 37 | + git clone https://github.com/tamaraiselvan/Base-django-project-Setup.git |
38 | 38 | ```
|
39 |
| -2. Create a virtual environment |
| 39 | +2. Create a virtual environment. |
40 | 40 | ```sh
|
41 | 41 | python -m venv virtualenviron_name
|
42 | 42 | ```
|
43 |
| -3. Activate the environment |
| 43 | +3. Activate the environment. |
44 | 44 | ```sh
|
45 | 45 | virtualenviron_name\Scripts\activate
|
46 | 46 | ```
|
47 |
| -4. Install Requirements from the Requirements.txt file |
| 47 | +4. Install Requirements from the Requirements.txt file. |
48 | 48 | ```sh
|
49 | 49 | pip install -r requirements.txt
|
50 | 50 | ```
|
51 |
| -5. Once you installed the requirements migrate the datebase |
| 51 | +5. Once you installed the requirements, migrate the database. |
52 | 52 | ```sh
|
53 | 53 | python manage.py migrate
|
54 | 54 | ```
|
55 |
| -6. Once after migrating, Create a superuser account |
| 55 | +6. Once after migrating, create a superuser account. |
56 | 56 | ```sh
|
57 | 57 | python manage.py createsuperuser
|
58 | 58 | ```
|
59 |
| -7. Run the server locally on your system |
| 59 | +7. Run the server locally on your system. |
60 | 60 | ```sh
|
61 | 61 | python manage.py runserver
|
62 | 62 | ```
|
63 |
| -8. Open your browser and type |
| 63 | +8. Open your browser and type. |
64 | 64 | ```sh
|
65 | 65 | http://127.0.0.1:8000/
|
66 |
| - ``` |
| 66 | + ``` |
| 67 | + |
| 68 | +## License |
| 69 | +Licensed under the MIT License. |
| 70 | +Copyright © 2022 TS Tamarai Selvan [Copy of the license](LICENSE). |
0 commit comments