Simple Run

# Simple Run

MrDoc is written based on the `Django` framework of the `Python3` language. Before installing MrDoc, please ensure that the `Python3` programming language is installed on the target computer.

>d On the Linux platform, commands such as `pip` and `python` in the following operations may need to be replaced with `pip3` and `python3`. Please judge for yourself.

## 0. Preparation

Operating systems:

- Windows
- Linux
- macOS

Install the Python environment:

- [Python 3.9+](https://www.python.org/ "Python 3.9+")

## 1. Download the source code

The open-source edition of MrDoc hosts its source code on Gitee, the code hosting platform under Open Source China, and on the popular code hosting platform `GitHub`. The project addresses are:

- Gitee: [https://gitee.com/zmister/MrDoc](https://gitee.com/zmister/MrDoc)
- GitHub: [https://github.com/zmister2016/MrDoc](https://github.com/zmister2016/MrDoc)

### 1.1. Install Git

MrDoc recommends using the Git tool to obtain and update the project code.

If Git is installed on your computer, you can skip to the next step;

If Git is not installed on your computer, you can visit the Git official website (https://git-scm.com/ ) to look up the installation method, and then proceed to the next step.

### 1.2. Pull the project source code

If the `Git` tool is installed on your computer, you can directly clone the MrDoc source code to your local computer using the `git clone` command. The command is:

```
git clone https://gitee.com/zmister/MrDoc
```

## 2. Install the required third-party libraries

All third-party libraries required for installing MrDoc are described in the requirements file. Open the command-line interface, and in the /Mrdoc/ directory, run the following `pip` command to install all third-party libraries required by MrDoc:

```bash
pip install -r requirements.txt
```

## 3. Initialize the database

After installing the required third-party libraries and configuring the database information, we need to initialize the database.

> MrDoc uses the sqlite database for data storage by default. If you need to use another database, please refer to the document: [Custom Database Configuration](http://mrdoc.zmister.com/project-7/doc-1364/)

Open the command-line interface in the project path and run the following command:

```
python manage.py makemigrations
```

Then, run the following command:

```
python manage.py migrate
```

After execution is complete, the database initialization is finished.

## 4. Create an administrator account

After initializing the database, you need to create an administrator account to manage the entire MrDoc. Open the command-line terminal in the project path and run the following command:

```
python manage.py createsuperuser
```

Follow the prompts to enter the username, email address, and password.

>d The entered password will not be displayed in the terminal. After entering it, press Enter.

## 5. Test running MrDoc

After completing the above steps, you can run and use MrDoc.

In a test environment, you can use Django's built-in server to run MrDoc. The command is:

```python
python manage.py runserver 0.0.0.0
```

Run the above command and visit the local IP address. If the page shown in the figure below appears, it indicates that `MrDoc` has been installed successfully:

![hehehe](/media//202003/2020-03-29_210228_1585486987.jpg)

If the test run is fine, you can deploy it to the corresponding server. For details, see [Deployment Guide](https://doc.mrdoc.pro/doc/1362/)

@[frag](id=8 title=Pro Edition Guide - General)