Skip to content

Instantly share code, notes, and snippets.

@NoahRR
Created November 2, 2020 19:31
Show Gist options
  • Save NoahRR/47416b1cb8beca8815fc47c698cf716b to your computer and use it in GitHub Desktop.
Save NoahRR/47416b1cb8beca8815fc47c698cf716b to your computer and use it in GitHub Desktop.
Explanation of the various functionalities in nexusorganizer.com
# Nexus-Organizer
A file creation and organization web application intended for a more productive research process. The app is also customizable to fit a variety of needs.
## Notes
The application is still in development stage, and just coming out for early users.
Once the application gets far enough, a complete README and a video tutorial will be created.
Enjoy the app!
## INDEX
For ease of editability and readability, this index will give context & point to all relevant parts of this app
----
This is a django project with 2 apps.
The first, named test_nexus, contains index.html, login, and signup. This app handles everything before the main application.
The second, named home_nexus, contains the Nexus Organizer application. Full functionality is here.
----
Terminology:
Repository / Repo : Base main giant drop down folders that contain both folders and files. IN BACKEND CALLED 'LOCAL REPO'
Files : files within folders and repos. IN BACKEND CALLED 'TAGS'
tags : tags associated with each file. IN BACKEND CALLED 'RELATED TAGS'
##### CSS
All main app styles are located in **home_nexus/static/home_nexus/styleon.css**
Authentication (index, login, logout) styles are located in **test_nexus/static/test_nexus/first.css**
##### JS
All javascript in bundled in **home_nexus/static/home_nexus/scripts/grunt_build/allscripts.js**
Unbundlered (un-concatenated) JS is located in **home_nexus/static/home_nexus/scripts/**
note: only allscripts.js is linked to webpage, other JS is organized for development
##### HTML
All main app html is located in **home_nexus/templates/**
All authentication html is located in **home_nexus/templates/**
----
### JS page summaries
##### miscellaneous_fnc.js
Unclassified functions
##### miscellaneous_event_handler.js
Unclassified Event Handlers
##### Specific_functions/
All classified by name JS pages ... TODO
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment