Major Updation

README.md

@@ -1,21 +1,57 @@
-## ASET-ALIAS
+## ALiAS: Amity Linux Assistance Sapience
 - The following repo contains the source code for the official website of Amity Linux Assistance Sapience. 
 - The website is hosted on gh-pages itself. 
-
+- This Website uses Staticjinja to build top-level HTML files. Follow Instructions to modify the HTML Files.
 
 ## Contribute 
-- Feel free to open any issue or recommend any changes which you want to see in the website. 
+- Feel free to open an issue or recommend any changes which you want to see in the website. 
 - Adhere to the guidelines mentioned below if you want to contribute. 
 
-
 ## Guidelines 
 - Make sure your PR contains `one` logical change only!
-- In case there are multiple commit in your PR squash them into one. Ref : 
+- In case there are multiple commits in your PR squash them into one. Ref : 
 - `https://makandracards.com/makandra/527-squash-several-git-commits-into-a-single-commit`
 - Make sure you update your REMOTE ORIGIN in case you have forked this repo : 
 - `https://help.github.com/articles/syncing-a-fork/`
 - Once you update the forked repo make sure you `rebase` the changes and then open the PR. 
-- Ref : `http://stackoverflow.com/questions/7244321/how-do-i-update-a-github-forked-repository`
+- Ref: `http://stackoverflow.com/questions/7244321/how-do-i-update-a-github-forked-repository`
+
+## Instructions
+
+### Create and activate a python virtual environment
+Create a virtual environment (You may have to run ```pip install venv```)
+```
+virtualenv VENV_NAME
+or
+python -m venv VENV_NAME
+```
+Activate Environment:
+Linux:
+```
+source VENV_NAME/bin/activate
+```
+Windows:
+```
+./VENV_NAME/Scripts/activate
+```
+
+### Install the requirements
+```
+pip install -r requirements.txt
+```
+
+### Run build.py
+Run build.py to automatically build and render top level html files. (Optional: Run SimpleHTTPServer alongside for easy testing)
+```
+python build.py & python -m SimpleHTTPServer
+```
+
+### Make your changes
+Don't make any changes to top-level HTML Files. Navigate to ```templates``` folder and make required changes in the required section/module.
+StaticJinja will not track any changes made to any javascript/CSS/JSON files. Re-compile build.py to update any changes made to JSON files (no re-compile required in case of js/CSS).
+
+### Preview your result
+If you are using SimpleHTTPServer, you can view the changes at localhost:8000. If not, double-clicking the rendered index.html to view the result
 
 ## Contributors 
 - @thisisayush
@@ -24,3 +60,5 @@
 - @ConformalTomb
 - @aniketmaithani 
 - @bhanuvrat
+- @ATB00ker
+- @vipulgupta2048

build.py

@@ -0,0 +1,85 @@
+import json,os,re
+from staticjinja import make_site
+import markdown
+#Path to data folder
+data_folder = os.path.abspath(os.path.dirname(__file__)) + '/data'
+#Replace // and \ with /
+data_folder = re.sub(r"(\/\/){1}|(\\){1}", '/', data_folder)
+
+def convertToHtml(text):
+    print(text.replace("\\n","\n"))
+    return markdown.markdown(text.replace("\\n","\n"), output_format="html5").replace('\n', "<br>")
+
+if __name__ == "__main__":
+    data_home = {}
+    events = {}
+    site_meta = {}
+    webinars = {}
+    communities = {}
+    projects = {}
+    #Open and Read JSON Files
+    try:
+        with open(data_folder+'/data-home.json') as json_file:
+            data_home = json.load(json_file)[0]
+        with open(data_folder+'/events.json') as json_file:
+            events = json.load(json_file)
+        with open(data_folder+'/site-meta.json') as json_file:
+            site_meta = json.load(json_file)[0]
+        with open(data_folder+'/webinars.json') as json_file:
+            webinars = json.load(json_file)
+        with open(data_folder+'/communities.json') as json_file:
+            communities = json.load(json_file)
+        with open(data_folder+'/projects.json') as json_file:
+            projects = json.load(json_file)
+    except Exception as e:
+        print(e.message)
+    #Convert Markdown to HTML for selected
+    for event in events:
+        event['description'] = convertToHtml(event['description'])
+    data_home['alumni_description'] = convertToHtml(data_home['alumni_description'])
+
+    for community in communities:
+        community['desc'] = convertToHtml(community['desc'])
+
+    for project in projects:
+        project['description'] = convertToHtml(project['description'])
+
+    #Create Contexts
+    context_base = {'contact_links': site_meta['contact_links'],
+                'join_now_link': site_meta['join_now_link'],
+                'favicon': site_meta['favicon'],
+                'logo_dark': site_meta['logo_dark'],
+                'logo_light': site_meta['logo_light'],
+                'flashbox': site_meta['flashbox']
+                }
+    context_home = {'site_about':data_home['site_about'],
+                'site_history':data_home['site_history'],
+                'alumni_description':data_home['alumni_description'],
+                'services':data_home['services'],
+                'events': events,
+                'webinars': webinars,
+                'open_source_communities': data_home['open_source'],
+                'eventsP': data_home['eventsP'],
+                'team': data_home['team'],
+                'header_class': 'mainHeaderLayout1'
+                }
+    context_communities = {
+        'header_class': 'mainHeaderLayout',
+        'communities': communities
+    }
+    context_gallery = {
+        'header_class': 'mainHeaderLayout'
+    }
+    context_projects = {
+        'header_class': 'mainHeaderLayout1',
+        'projects': projects
+    }
+    context_home.update(context_base)
+    context_communities.update(context_base)
+    context_gallery.update(context_base)
+    context_projects.update(context_base)
+    contexts = [('index.html', context_home), ('communities.html', context_communities), ('gallery.html', context_gallery), ('showcase.html', context_projects)]
+
+    #StaticJinja
+    site = make_site(contexts = contexts)
+    site.render(use_reloader=True)