Google Document with Visual Examples: +https://docs.google.com/document/d/1Fg3sQPRXZgesOMI_l_D5dPP1pmXHFjZq-uUedpzqics/edit?usp=sharing
Install MySQL https://dev.mysql.com/downloads/installer/ (install +the second option useing all default options)
Install visual studio code https://code.visualstudio.com/ (or +whatever your preferred IDE is)
Install Git if you don’t already have it: +https://git-scm.com/download/win
Clone this repository
+Open the command prompt
cd to whatever folder you want to have the project in
git clone https://<YOUR_GITHUB_USERNAME>@github.com/paolaUWB/QuasarResearchWebsite.git
Check to see if all of the files were cloned
+dir
You should see a new “QuasarResearchWebsite” directory
Open project in visual studio code
+Open visual studio code
File -> Open folder and then navigate to the +QuasarResearchWebsite folder that you just cloned
Set up flask environment:
+Open a new terminal in visual studio
In the terminal python3 -m venv flaskEnv (this will take a
+couple of seconds to run)
WINDOWS ONLY: flaskEnv/Scripts/activate You should now see
+something like:
+(flaskEnv) PS C:\Users\guine\Desktop\test\QuasarResearchWebsite>
You may recieve an error message stating “running scripts is +disabled on this system”
To fix this open Windows PowerShell with administration +privileges
+To open, search “PowerShell” in the Windows Start menu and +select “Run as administrator” from the context menu
Enter ‘set-executionpolicy remotesigned’ to PowerShell
When asked “Do you want to change the execution policy?”, +respond with ‘Y’ for yes
MAC ONLY: source venv/bin/activate You should now see
+something like:
+(flaskEnv) PS C:\Users\guine\Desktop\test\QuasarResearchWebsite>
pip install flask
pip install PyMySQL
pip install Flask-WTF
pip install python-dotenv
pip install flask-sqlalchemy
pip install flask-migrate
pip install flask-login
pip install email-validator
For more instructions on using python environments in visual +studio, see +https://code.visualstudio.com/docs/python/environments
Add the secret environment variables:
+Create a new file in QuasarResearchWebsite/app/ and name it .env
Add your secrets to the file with the following:
+SECRET_KEY=<WHATEVER YOU WANT>
+MYSQL_DATABASE_PASSWORD=<YOUR MYSQL DB/ROOT PASSWORD>
+Add the path for downloads
+Create a new directory in QuasarResearchWebsite/app/ and name it +tmp
Create a new file in QuasarResearchWebsite/app/tmp and name it +quasars.csv
Setup the MySQL database:
+In the VSCode command line, start mysql with
+& cmd.exe /c "mysql -u root -p --verbose --local-infile=1 < app/quasarDB_win.sql",
+and enter your password for root user
python app/updateDatabase_win.py (this will update the paths
+to the images in the database)
Now check to see if things are working. In the visual studio
+terminal type flask run
If everything is working you should see something like:
+(flaskEnv) PS C:\Users\guine\Desktop\test\QuasarResearchWebsite> flask run
+* Environment: production WARNING: This is a development server. Do not use it in a production deployment.
+Use a production WSGI server instead.
+* Debug mode: off
+* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)``
+Follow the link on the last line to see if it runs. Your default +internet browser should open to the home page of the website.
Check that the images are loading correctly by going to the “Data +Access” page, clicking on a row and seeing if the image shows up.
Voila! Hopefully it is working :)
Setup Instructions: +https://www.sphinx-doc.org/en/master/usage/installation.html
Tutorial: +https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
Basic MySQL Administration: +https://itconnect.uw.edu/connect/web-publishing/shared-hosting/using-mysql-on-shared-uw-hosting/basic-mysql-administration/
Troubleshooting Steps: +https://itconnect.uw.edu/connect/web-publishing/shared-hosting/troubleshooting/
If the Data Access page doesn’t work (E.g. “Internal Server Error”, +data not displaying, etc.) 1. Go to init.py 1. Change the port +number in the method connect_db() to have your port number
To update and access most recent files enter git pull into the
+terminal when you are in your QuasarResearchWebsite folder
To push your most recent files to the master branch 1. Enter
+git status to list out files that have been added/changed. the
+names of the files should be red 1. Add files that are unecessary to
+the project to .gitignore 1. Enter git status To list out files
+again to check if those files were removed. 1. Enter git add . To
+the terminal. 1. Enter git status to the terminal. The names of
+the files should now be green. 1. Enter git commit -m "message".
+You can change the message to anything you want but it should be
+somewhat descriptive. 1. Enter git `push to the terminal. 1. If this
+is your first time doing so you should type in “git push
+–set-upstream origin YourBranch”. Change “YourBranch” to the actual
+name of the branch. 1. Go to the Github repository to merge your
+request
If you recieve the error message: “running scripts is disabled on this system”
+1. Open Windows PowerShell with administration privileges
+1. To open, search “PowerShell” in the Windows Start menu and select “Run as administrator” from the context menu
+1. Enter set-executionpolicy remotesigned to PowerShell
+1. When asked “Do you want to change the execution policy?”, respond with Y for yes
+1. For more information visit: https://www.faqforge.com/windows/windows-powershell-running-scripts-is-disabled-on-this-system/
To add the mysql exe file to the path 1. type “path” into the windows
+search bar and click “edit the system environment variables” 1. click
+on environment variables 1. click on path, then edit, then new 1.
+then add the paths C:\Program Files\MySQL\MySQL Shell 8.0\bin\
+and C:\Program Files\MySQL\MySQL Server 8.0\bin\ to the list 1.
+click ok/apply 1. restart your computer
If you recieve the error mesage: module not found
Type python -m pip list into VS Code’s terminal
This will list all installed packages
If the package you need is not in the list, enter
+pip install [package name] to the terminal
For example, if you need to install PyMySql, enter
+pip install PyMySQL to the terminal
Setting the virtual enviroment in VS Code
+type “path” into the windows search bar and click “edit the +system environment variables”
Use CTRL + SHIFT + P
click on “Python: select interpreter”
Select the path that has flaskEnv/Scripts/ in the path name
To learn more check this page: +https://code.visualstudio.com/docs/python/environments
1. The user database and login system follows these +two tutorials
+++
To view all users 1. flask shell
+1. See list of all usernames
++1. users = User.query.all() +1. users
+
1. users = User.query.all() +1.
++++
+- ::
- +
+
+- for u in users:
- +
… print(u.id, u.username) +…
+
1. flask shell +1. u = User(username=’INSERT USERNAME HERE’, email=’INSERT EMAIL HERE’) +1. u.set_password(‘INSERT PASSWORD HERE’) +1. db.session.add(u) +1. db.session.commit()
+flask shell
users = User.query.all()
for u in users: +… db.session.delete(u) +…
+db.session.commit()
To delete a specific user
+flask shell
Find the id of the user you want to delete.
u = User.query.get(INSERT ID HERE)
db.session.delete(u)
db.session.commit()
' + _('Hide Search Matches') + '
') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/documentation/build/html/_static/documentation_options.js b/documentation/build/html/_static/documentation_options.js new file mode 100644 index 00000000..23fc755e --- /dev/null +++ b/documentation/build/html/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '0.0.1', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/documentation/build/html/_static/file.png b/documentation/build/html/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)