Interactive-User-Guides-Template
Interactive-User-Guides-Template copied to clipboard
alialaei1
Interactive User Guides Template Based on Django
Interactive User Guides Template Based on Django
This project is a web-based interactive user guide template built using the Django web framework. It provides a flexible and customizable platform for creating user guides that can be used to educate and onboard new users or to provide assistance and support for existing users.
How to Run
This Django project is designed to be easy to set up and run. Here are the steps you need to follow to get started:
Prerequisites
Before you can run this Django project, you need to have the following software installed:
Python 3.6 or later
Installation
To install this Django project, follow these steps:
1- Clone the project repository to your local machine using the command:
git clone https://github.com/alialaei110/Interactive-User-Guides-Template.git
2- Navigate to the project directory using the command:
cd Interactive-User-Guides-Template
3- Create a virtual environment and activate it using the following commands:
python -m venv env
source env/Scripts/activate
4- Install the project dependencies using the command:
pip install -r requirements.txt
Running the Project
for the first time, before running server run commands:
python manage.py makemigrations
python manage.py migrate
Once you have installed and configured the Django project, you can run it using the following command:
python manage.py runserver
This command will start the Django development server, and you should be able to access the project by navigating to http://127.0.0.1:8000/ in your web browser.
That's it! You should now have this Django project up and running on your local machine.
Create user for the first time
create a superuser by writing the following command:
python manage.py createsuperuser
We then write the following credentials step by step. We can fill these credentials according to our preferences:
Username: admin
Email address: [email protected]
Password: ********
Password (again): ********
Note: After filling a row, press “Enter” to fill the other information.
Now the superuser will be created if we have entered all fields correctly.
How to Use
Create and edit data
Open your web browser and navigate to http://127.0.0.1:8000/admin/. Log in using the superuser account that you created in Previous step. You should now be able to manage your datas through the admin site.
| Section | Description |
|---|---|
| Users | In this section, you can manage users (add or delete) |
| Topic | In this section, you can create the main topics for which you want to raise questions or issues, for example: training a specific device or a specific topic of an application. Note that by choosing a unique link for your topic, you can share it through the link or QR code. |
| Questions | In this section, you can create as many questions as you want for each type, for example: training on turning on the device or training on connecting the device to the Internet or training on registering on the website |
| Answers | In this section you can create an answer for each question, on the answer page you can use video, photos, fonts and various colors like a weblog. |
License
MIT License
Free Software!
alialaei1