{% extends 'aurora/layout.html' %}

{% block title %}Index Page{% endblock %}

{% block body %}
    <h1>Welcome to Aurora</h1>
    <p>Aurora is an MVC web framework for creating CRUD applications quickly and simply.</p>
    <p>It based on REST architecture. In another word it is a RESTFUL web framework.</p>
    <p>Aurora is written in <a href="https://www.python.org/">Python</a>, and built on <a href="https://flask.palletsprojects.com/">Flask</a>.</p>
    
    <hr class="divider divider-gradient">

    <h1>Installation</h1>
    <p>You can install Aurora by running:</p>
    <section class="cli">
        <code>$ pip install aurora-mvc</code>
    </section>
    
    <hr class="divider divider-gradient">

    <h1>Usage</h1>
    <h2>Get Started</h2>
    <p>To get started with Aurora simply do the following steps:</p>
    <p><strong>1-</strong> Create the project (root app) directory:</p>
    <section class="cli">
        <code>$ mkdir <em>my_app</em></code>
    </section>
    <div class="alert alert-info" style="margin-bottom: 2rem;">
        Here <code class="inline-code">my_app</code> is a variable name. Change it to anything of your choice at any time you want.
    </div>

    <p><strong>2-</strong> Install a python virtual environment in the same path that the project directory exists:</p>
    <section class="cli" style="margin-bottom: 2rem;">
        <code>$ python -m venv <em>venv</em></code>
    </section>

    <p><strong>3-</strong> Activate the virtual environment:</p>
    <strong style="display: block; margin-bottom: 0.5rem;">Linux / Mac:</strong>
    <section class="cli">
        <code>$ . venv/bin/activate</code>
    </section>
    
    <strong style="display: block; margin-bottom: 0.5rem;">Windows:</strong>
    <section class="cli" style="margin-bottom: 2rem;">
        <code>$ venv\scripts\activate</code>
    </section>
    
    <p><strong>4-</strong> Navigate to the project directory:</p>
    <section class="cli">
        <code>(venv) cd <em>my_app</em></code>
    </section>
    <div class="alert alert-warn" style="margin-bottom: 2rem;">
        Notice that the project directory must be empty, otherwise you will get an error on the next step.
    </div>

    <p><strong>5-</strong> Initialize the root app with Aurora via python shell:</p>
    <section class="cli">
        <code>(venv) python</code>
        <code>>>> from aurora import init_app</code>
        <code>>>> init_app.start()</code>
    </section>
    <div class="alert alert-ok" style="margin-bottom: 2rem;">
        Congratulations! You successfully initialized the root app. Now you are ready to get started with Aurora.
    </div>

    <p><strong>6-</strong> To start the root app run the following command:</p>
    <section class="cli" style="margin-bottom: 2rem;">
        <code>(venv) python app.py</code>
    </section>
    
    <h2>Next Steps</h2>
    <p>Documentation: <strong><a href="https://github.com/heminsatya/aurora/docs/">Aurora Docs</a></strong></p>
    <p>Changelog: <strong><a href="https://github.com/heminsatya/aurora/changes/">Aurora Changes</a></strong></p>
    <p>Issues: <strong><a href="https://github.com/heminsatya/aurora/issues/">Aurora Bug Tracker</a></strong></p>
    <p>Source: <strong><a href="https://github.com/heminsatya/aurora/">Aurora GitHub Repo</a></strong></p>
    <p>PyPI: <strong><a href="https://pypi.org/project/aurora-mvc/">Aurora PyPI Page</a></strong></p>
    
    <hr class="divider divider-gradient">

    <h1>Dependencies</h1>

    <h2>Packages:</h2>
    <ul>
        <li><strong><a href="https://pypi.org/project/Flask/">Flask</a></strong></li>
        <li><strong><a href="https://pypi.org/project/click/">Click</a></strong> -- <em>Will be installed by flask.</em></li>
        <li><strong><a href="https://pypi.org/project/WTForms/">WTForms</a></strong> -- If you are using WTForms.</li>
    </ul>

    <h2>Database APIs:</h2>
    <ul>
        <li><strong><a href="https://docs.python.org/3/library/sqlite3.html">sqlite3</a></strong> -- If you are using SQLite Database. <em>Included in the standard python library.</em></li>
        <li><strong><a href="https://pypi.org/project/psycopg2/">psycopg2</a></strong> -- If you are using PostgreSQL Database.</li>
        <li><strong><a href="https://pypi.org/project/mysql-connector-python/">mysql.connector</a></strong> -- If you are using MySQL Database.</li>
    </ul>

{% endblock %}