Quick Start

> i If Docker is installed on your computer, we highly recommend using Docker Compose for one-click deployment. For details, please refer to:

# Quick Start

MrDoc is built with the **Django** framework on **Python 3**.
Before installing MrDoc, please make sure **Python 3** is already installed on your machine.

> **Note for Linux users**
> On some Linux distributions, you may need to use `python3` and `pip3` instead of `python` and `pip`. Adjust as needed.

---

## 0. Requirements

Operating systems supported:

* Windows
* Linux
* macOS

Python environment:

* **Python 3.9+**
  Download: [https://www.python.org/](https://www.python.org/)

---

## 1. Download the Source Code

The open-source version of MrDoc is hosted on both Gitee and GitHub:

* **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

We recommend using Git to download and keep the project up to date.

* If Git is already installed, continue to the next step.
* If not, please visit the official website ([https://git-scm.com/](https://git-scm.com/)) for installation instructions.

### 1.2 Clone the repository

Once Git is installed, you can clone the MrDoc repository using:

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

(You may replace the URL with the GitHub repository if preferred.)

---

## 2. Install Dependencies

All required Python packages are listed in the `requirements.txt` file.
Open a terminal window, navigate to the `/MrDoc/` directory, and run:

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

This will install all dependencies needed to run MrDoc.

---

## 3. Initialize the Database

After installing the dependencies and configuring your database settings, initialize the database schema.

> **Note**
> By default, MrDoc uses **SQLite** as its storage backend.
> To use another database, please refer to:
> *Custom Database Configuration* — [http://mrdoc.zmister.com/project-7/doc-1364/](http://mrdoc.zmister.com/project-7/doc-1364/)

In the project directory, run:

```bash
python manage.py makemigrations
```

Then apply the migrations:

```bash
python manage.py migrate
```

Once completed, the database is ready.

---

## 4. Create an Admin User

Next, create an administrator account for managing MrDoc.

Run:

```bash
python manage.py createsuperuser
```

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

> **Tip**
> The password will not be shown on screen when typing. Press Enter when finished.

---

## 5. Run MrDoc in Development Mode

After completing the steps above, you can now launch MrDoc.

For development and testing, use Django’s built-in server:

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

Open your browser and visit your machine’s IP address.
If you see a page similar to the screenshot below, MrDoc has been installed successfully:

![hehehe](https://doc.mrdoc.pro/media/202003/2020-03-29_210228_1585486987.jpg)

If everything works as expected, you may proceed with deploying MrDoc to a production server.
See the **Deployment Guide** for more details:
[https://doc.mrdoc.pro/doc/1362/](https://doc.mrdoc.pro/doc/1362/)