added setting up instructions in README

sympy · Apr 12, 2020 · 07fa62f · 07fa62f
1 parent 834358b
commit 07fa62f
Show file tree

Hide file tree

Showing 4 changed files with 89 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -48,6 +48,72 @@ We use submodules to include external libraries in sympy-live::
 This is sufficient to clone appropriate repositories in correct versions
 into sympy-live (see git documentation on submodules for information).
 
+Setting Up for Testing PR 144
+-----------------------------
+
+You must have python3 installed. You can check your version by::
+
+    $ python3 -V
+
+The version must be greater than 3.4. If not present you can install it by::
+
+    $ sudo apt install python3
+
+You need to create the virtual environment and activate it::
+
+    $ sudo apt-get install python3-venv
+    $ python3 -m venv env
+    $ source env/bin/activate
+
+SymPy Live uses MySQL for database purpose. So you need to setup mysql::
+
+    $ sudo apt-get install mysql-server
+    $ sudo apt-get install libmysqlclient-dev
+    $ sudo apt-get install python3-dev
+    $ sudo systemctl start mysql
+    $ sudo mysql
+
+This will open mysql. You will now have to create a new database with name {database_name}. Create a new user {user_name} and password {user_password}. Grant all previleges to <user_name> on {database-name}::
+
+    mysql> CREATE DATABASE {database_name};
+    mysql> UPDATE mysql.user SET authentication_string = PASSWORD('{user_password}') WHERE User = '{user_name}';
+    mysql> FLUSH PRIVILEGES;
+    mysql> GRANT ALL PRIVILEGES ON *.* TO '{user_name}'@'localhost' IDENTIFIED BY '{user_password}';
+
+To ensure that the database server launches after a reboot, run the following command::
+
+    $ sudo systemctl enable mysql
+
+Now in settings.py set up the database for MySQL::
+
+    DATABASES = {
+        'default': {
+            'ENGINE': 'django.db.backends.mysql',
+            'HOST': '127.0.0.1',    # DB's IP address
+            'PORT': '3306',
+            'NAME': '{database_name}',
+            'USER': '{user_name}',
+            'PASSWORD': '{user_password}',
+        }
+    }
+
+Install dependencies from requirements.txt::
+
+    $ pip install -r requirements.txt
+
+migrate the changes::
+
+    $ python3 manage.py makemigrations
+    $ python3 manage.py migrate
+    $ python3 manage.py createsuperuser     # will be used to login into admin panel
+
+And fianlly::
+
+    $ python3 manage.py runserver
+
+This runs the site on localhost. But before using the SymPy Live go to admin panel. There you need to create new user 'anonymous'. You can keep password anythong but name must be exactly same.
+Congratulations, now you can test the SymPy Live.
+
 Development server
 ------------------
 

diff --git a/shell/views.py b/shell/views.py
@@ -677,6 +677,7 @@ def index(request):
 
     context = {
         # 'server_software': os.environ['SERVER_SOFTWARE'],
+        'hosted_on_app_engine': os.getenv('GAE_APPLICATION', None),
         'application_version': LIVE_VERSION,
         'date_deployed': LIVE_DEPLOYED,
         'python_version': sys.version,

diff --git a/sympy_live/settings.py b/sympy_live/settings.py
@@ -105,7 +105,7 @@
     DATABASES = {
         'default': {
             'ENGINE': 'django.db.backends.mysql',
-            'HOST': '127.0.0.1', # DB's IP address
+            'HOST': '127.0.0.1',    # DB's IP address
             'PORT': '3306',
             'NAME': 'sympyDB',
             'USER': 'root',

diff --git a/templates/base.html b/templates/base.html
@@ -5,6 +5,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1" />
     <title>{% block title %}{% endblock %}</title>
     <link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.css" rel="stylesheet" type="text/css" />
+    {% if hosted_on_app_engine %}
     <link rel="stylesheet" href="/static-{{application_version}}/external/css/reset.css" type="text/css" media="screen" />
     <link rel="stylesheet" href="/static-{{application_version}}/external/css/responsive-gs-12col.css" type="text/css" media="screen" />
     <link rel="stylesheet" href="/static-{{application_version}}/css/base.css" type="text/css" media="screen" />
@@ -19,6 +20,22 @@
     <link rel="stylesheet" type="text/css" href="static-{{application_version}}/sympy-live/css/live-core.css" />
     <script type="text/javascript" src="static-{{application_version}}/sympy-live/javascript/live-autocomplete.js"></script>
     <script type="text/javascript" src="static-{{application_version}}/sympy-live/javascript/live-core.js"></script>
+    {% else %}
+    <link rel="stylesheet" href="/static/external/css/reset.css" type="text/css" media="screen" />
+    <link rel="stylesheet" href="/static/external/css/responsive-gs-12col.css" type="text/css" media="screen" />
+    <link rel="stylesheet" href="/static/css/base.css" type="text/css" media="screen" />
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,400,700|Gentium+Basic" rel="stylesheet" type="text/css" />
+    <link rel="icon" href="/static/SymPy-Favicon.ico" />
+    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script>
+    <script type="text/javascript" src="/static/javascript/main.js"></script>
+    <script type="text/javascript" src="static/external/javascript/classy.js"></script>
+    <script type="text/javascript" src="static/sympy-live/javascript/utilities.js"></script>
+    <script type="text/javascript" src="static/sympy-live/javascript/expand_right.js"></script>
+    <link rel="stylesheet" href="static/sympy-live/css/live-autocomplete.css" type="text/css" />
+    <link rel="stylesheet" type="text/css" href="static/sympy-live/css/live-core.css" />
+    <script type="text/javascript" src="static/sympy-live/javascript/live-autocomplete.js"></script>
+    <script type="text/javascript" src="static/sympy-live/javascript/live-core.js"></script>
+    {% endif %}
 
     <script type="text/x-mathjax-config">
       MathJax.Hub.Config({
@@ -66,7 +83,11 @@
   <body>
     <div class="container">
       <header>
+        {% if hosted_on_app_engine %}
         <h1><a href="/"> <img src="/static-{{application_version}}/images/logo.png" alt="SymPy Logo" /> SymPy</a></h1>
+        {% else %}
+        <h1><a href="/"> <img src="/static/images/logo.png" alt="SymPy Logo" /> SymPy</a></h1>
+        {% endif %}
         <div id="mobile-menu"><i class="icon-ellipsis-vertical"></i></div>
       </header>
       <nav id="main-navigation" class="row">