GSOC2017AppStore - Revision history

Abhijithanilkumar: /* Weekly Reports */

2017-08-28T20:48:31Z

Weekly Reports

← Older revision		Revision as of 20:48, 28 August 2017
Line 206:		Line 206:
	* Added a new active field to the Apps model. Only those apps with active=True will show up in the main page of the website.		* Added a new active field to the Apps model. Only those apps with active=True will show up in the main page of the website.
	* The URL numbers have been changed from numbers to names to provide easy access for the bake-tool in the future.		* The URL numbers have been changed from numbers to names to provide easy access for the bake-tool in the future.

			===Week 10 (Aug 2-Aug 8)===
			'''Tasks Completed'''
			<pre>
			* Added Instructions section
			* Added Maintenance section
			* Added code to parse bakeconf
			* Editors can choose default download now
			* Update the VM
			</pre>
			'''Summary'''
			* A new tab has been added in the App Page that supports markdown. Editors can edit this sections to include installation instructions.
			* Maintenance tab has been added in the App Page, editable by editors. It supports markdown and can be used to mention the maintenance aspect of the App.
			* Basic structure of the function to parse the bakeconf has been added to the backend, but it is not integrated since the structure of bake file isn't fixed yet.
			* Editors can choose the link to which download button points.

			===Week 11 (Aug 9-Aug 15)===
			'''Tasks Completed'''
			<pre>
			* Resolve open GitHub issues regarding the workflow.
			</pre>
			'''Summary'''
			* Resolved open issues : [https://github.com/abhijithanilkumar/ns-3-AppStore/issues?q=is%3Aissue+is%3Aclosed Closed]

			===Week 12 (Aug 16-Aug 22)===
			'''Tasks Completed'''
			<pre>
			* Resolve open GitHub issues.
			</pre>
			'''Summary'''
			* Resolved open issues : [https://github.com/abhijithanilkumar/ns-3-AppStore/issues?q=is%3Aissue+is%3Aclosed Closed]

			===Final Evaluations===

Abhijithanilkumar: /* Week 9 (July 26-Aug 1) */

2017-08-28T20:31:31Z

Week 9 (July 26-Aug 1)

← Older revision		Revision as of 20:31, 28 August 2017
Line 200:		Line 200:
	'''Tasks Completed'''		'''Tasks Completed'''
	<pre>		<pre>
	*~~WIP~~		* Added Active field to apps
			* Change URL names from numbers to names
	</pre>		</pre>
	'''Summary'''		'''Summary'''
	* ~~WIP~~		* Added a new active field to the Apps model. Only those apps with active=True will show up in the main page of the website.
			* The URL numbers have been changed from numbers to names to provide easy access for the bake-tool in the future.

Abhijithanilkumar: /* Weekly Reports */

2017-07-26T20:53:14Z

Weekly Reports

← Older revision		Revision as of 20:53, 26 July 2017
Line 176:		Line 176:
	* Since the new website works on Bootstrap, the extra dependency on Materialize has been removed.		* Since the new website works on Bootstrap, the extra dependency on Materialize has been removed.
	* The VM has been updated with the latest code and it is made available to developers for feedback, as part of Phase 2.		* The VM has been updated with the latest code and it is made available to developers for feedback, as part of Phase 2.

			===Second Phase Evaluations (July 24-July 28)===
			Over Phase 2, the issues identified in the App Store has been rectified, mainly, frontend issue. The frontend has undergone major changes as we moved from Materialize to Cytoscape design. Few new features like screenshot support, bakefile support has been added. The AppStore is setup at [http://ns-apps.ee.washington.edu ns-apps.ee.washington.edu] and is available to the public.

			===Plan for Phase 3===
			* Switch from Username-Password accounts to Google OAuth login (to prevent spammers and bots).
			* Change the URL structures (Move to names rather than numbers, Use easily decipherable names. Eg : http://ns-apps.ee.washington.edu/media/release_files/sift-v1_0.xml for SiFt module v1.0).
			* Autopopulate the App Page fields from the stored bakeconf file.
			* Authors will have the ability to edit the app, add screenshots, writeup on dependencies etc. (Markdown Supported)
			* New Tabs : Maintenance (Shows the current maintainer, status of the module, etc.), Dependencies (Specific instructions from author to handle dependencies)
			* Logged In users can provide feedback (Comments thread)
			* The navigation panel of the website has to be redesigned to match that of other ns-3 pages, including the links and pull-down menu.
			* Apps can be made inactive : An inactive app will not show up on the search results or the main page. This can be done by using a BooleanField, active.
			* Database needs to be migrated to production, MySQL is not suitable for production. We need to switch to PostgreSQL for production. A cron job needs to be run to frequently backup the database.
			* Provide a well built documentation on using the website.
			* Build a Test suite and use Travis for continuous integration.

			Deliverables : Fully functional ns-3 app store is deployed by August 29.

			Enhancement : Complete all envisioned bake.py extensions to make use of the app store at the command line. That is, implement commands that can be used to fetch and app from the App Store and to update it later using command line. This can be done by using Django Rest Framework to open up APIs for the command line functions to access the app store.

			===Week 9 (July 26-Aug 1)===
			'''Tasks Completed'''
			<pre>
			*WIP
			</pre>
			'''Summary'''
			* WIP

Abhijithanilkumar: /* Week 8 (July 19-July 25) */

2017-07-26T20:38:00Z

Week 8 (July 19-July 25)

← Older revision		Revision as of 20:38, 26 July 2017
Line 166:		Line 166:
	'''Tasks Completed'''		'''Tasks Completed'''
	<pre>		<pre>
	* Integrate ~~Cytoscape AppStore design~~ with ~~our~~ backend ~~design (WIP)~~		* Add Cytoscape frontend code to our repository
			* Integrate the new frontend with the old backend
			* Remove materialize
			* Update the VM
	</pre>		</pre>
	'''Summary'''		'''Summary'''
	* ~~WIP~~		* As decided in the previous week, we moved to Cytoscape design since Materialize was found to not suite our needs.
			* The new frontend from Cytoscape was integrated with the backend designed for ns-3 App Store.
			* Since the new website works on Bootstrap, the extra dependency on Materialize has been removed.
			* The VM has been updated with the latest code and it is made available to developers for feedback, as part of Phase 2.

Abhijithanilkumar: /* Weekly Reports */

2017-07-19T06:30:53Z

Weekly Reports

← Older revision		Revision as of 06:30, 19 July 2017
Line 162:		Line 162:
	* Unfortunately, Materialize design cannot be modified to match the exact look of Cytoscape Appstore.		* Unfortunately, Materialize design cannot be modified to match the exact look of Cytoscape Appstore.
	* A design decision was made this week, to compromise responsiveness and move to Cytoscape design. The Cytoscape frontend design will be integrated to our design over the next week.		* A design decision was made this week, to compromise responsiveness and move to Cytoscape design. The Cytoscape frontend design will be integrated to our design over the next week.

			===Week 8 (July 19-July 25)===
			'''Tasks Completed'''
			<pre>
			* Integrate Cytoscape AppStore design with our backend design (WIP)
			</pre>
			'''Summary'''
			* WIP

Abhijithanilkumar: /* Week 7 (July 12-July 18) */

2017-07-19T06:29:19Z

Week 7 (July 12-July 18)

← Older revision		Revision as of 06:29, 19 July 2017
Line 155:		Line 155:
	</pre>		</pre>
	'''Design Decision'''		'''Design Decision'''

	We have made a compromise on the current responsive decision to use the Cytoscape AppStore which does not take responsiveness into consideration. We have chose it since we feel that ns-3 AppStore is mainly intended for desktop users. A mail has been sent out to Cytoscape maintainers asking the kind of attribution they prefer when we use their design. Meanwhile, our backend code will be integrated to their design and the site will be made available to the developers.		We have made a compromise on the current responsive decision to use the Cytoscape AppStore which does not take responsiveness into consideration. We have chose it since we feel that ns-3 AppStore is mainly intended for desktop users. A mail has been sent out to Cytoscape maintainers asking the kind of attribution they prefer when we use their design. Meanwhile, our backend code will be integrated to their design and the site will be made available to the developers.


	'''Summary'''		'''Summary'''

Abhijithanilkumar: /* Week 7 (July 12-July 18) */

2017-07-19T06:28:59Z

Week 7 (July 12-July 18)

← Older revision		Revision as of 06:28, 19 July 2017
Line 154:		Line 154:
	* Tried modifying Materialize design to match Cytoscape design		* Tried modifying Materialize design to match Cytoscape design
	</pre>		</pre>
	'''Design Decision'''		'''Design Decision'''
	We have made a compromise on the current responsive decision to use the Cytoscape AppStore which does not take responsiveness into consideration. We have chose it since we feel that ns-3 AppStore is mainly intended for desktop users. A mail has been sent out to Cytoscape maintainers asking the kind of attribution they prefer when we use their design. Meanwhile, our backend code will be integrated to their design and the site will be made available to the developers.		We have made a compromise on the current responsive decision to use the Cytoscape AppStore which does not take responsiveness into consideration. We have chose it since we feel that ns-3 AppStore is mainly intended for desktop users. A mail has been sent out to Cytoscape maintainers asking the kind of attribution they prefer when we use their design. Meanwhile, our backend code will be integrated to their design and the site will be made available to the developers.
	'''Summary'''

			'''Summary'''
	* Since Cytoscape AppStore is a well designed website, we decided to change the looks of our site based on it.		* Since Cytoscape AppStore is a well designed website, we decided to change the looks of our site based on it.
	* Unfortunately, Materialize design cannot be modified to match the exact look of Cytoscape Appstore.		* Unfortunately, Materialize design cannot be modified to match the exact look of Cytoscape Appstore.
	* A design decision was made this week, to compromise responsiveness and move to Cytoscape design. The Cytoscape frontend design will be integrated to our design over the next week.		* A design decision was made this week, to compromise responsiveness and move to Cytoscape design. The Cytoscape frontend design will be integrated to our design over the next week.

Abhijithanilkumar: /* Week 7 (July 12-July 18) */

2017-07-19T06:28:21Z

Week 7 (July 12-July 18)

← Older revision		Revision as of 06:28, 19 July 2017
Line 152:		Line 152:
	'''Tasks Completed :'''		'''Tasks Completed :'''
	<pre>		<pre>
	* ~~Fix Frontend issues (Work In Progress!)~~		* Tried modifying Materialize design to match Cytoscape design
	</pre>		</pre>
			'''Design Decision'''
			We have made a compromise on the current responsive decision to use the Cytoscape AppStore which does not take responsiveness into consideration. We have chose it since we feel that ns-3 AppStore is mainly intended for desktop users. A mail has been sent out to Cytoscape maintainers asking the kind of attribution they prefer when we use their design. Meanwhile, our backend code will be integrated to their design and the site will be made available to the developers.
	'''Summary'''		'''Summary'''
	* ~~WIP~~		* Since Cytoscape AppStore is a well designed website, we decided to change the looks of our site based on it.
			* Unfortunately, Materialize design cannot be modified to match the exact look of Cytoscape Appstore.
			* A design decision was made this week, to compromise responsiveness and move to Cytoscape design. The Cytoscape frontend design will be integrated to our design over the next week.

Abhijithanilkumar: /* Weekly Reports */

2017-07-12T15:28:10Z

Weekly Reports

← Older revision		Revision as of 15:28, 12 July 2017
Line 114:		Line 114:
	* Website setup and made available for developers		* Website setup and made available for developers
	</pre>		</pre>
			'''Summary :'''

			Week 4 of the coding phase was spent in completing the remaining bugs in the website before the first launch.
			* The ElasticSearch bug which was identified in the previous week is fixed in this week by making use of the SearchQuerySet feature of haystack.
			* The remaining backend-frontend integration is complete now and the site is ready for first launch.
			* The website has been setup in the VM using gunicorn and nginx and it is made available for the developers for testing.

			===First Phase Evaluations (June 26-June 30)===
			As previously planned, the AppStore has been made available to users for testing. The AppStore is setup at [http://ns-apps.ee.washington.edu ns-apps.ee.washington.edu] and is available to the public. The documentation for using the site or for setting up your own instance of the AppStore can be found [https://github.com/abhijithanilkumar/ns-3-AppStore/wiki here]

			===Week 5 (June 27-July 4)===
			'''Tasks Completed :'''
			<pre>
			* Added comments and rating
			* Fixed overhang and spacing issues
			* Address Phase 1 review comments
			</pre>
			'''Summary'''
			* Users can now add their ratings and comments for the app they want. There is an issue in displaying the stars. This issue will be fixed in the coming weeks.
			* There were some overhang issues identified in some browsers. That has been fixed in this week.
			* During phase 1, we received a comment regarding the number of downloads in the site. It has been removed from the site since the feature is not so useful for ns-3 modules.

			===Week 6 (July 5-July 11)===
			'''Tasks Completed :'''
			<pre>
			* Fixed Firefox/IE height issues
			* Added smaller screen support
			* Added bakefile support
			* Added download page
			</pre>
			'''Summary'''
			* Issues were identified in Firefox and IE where heights were rendered differently which caused the site to appear differently in different browsers. This issue has been fixed by adding the correct padding to the pages.
			* To support smaller screens, the responsive nature of material design has been used. The sizes of different screens have been setup explicitly to account for the change.
			* The website has been modified to accept a bakeconf file and retrieve details from it. But, the details that must be retrieved from the file needs to be finalized.
			* The download button in the app page has been modified to point to a new page, which gives different options for downloading and setting up the module.
			===Week 7 (July 12-July 18)===
			'''Tasks Completed :'''
			<pre>
			* Fix Frontend issues (Work In Progress!)
			</pre>
			'''Summary'''
			* WIP

Abhijithanilkumar: /* Week 4 (June 20-June 26) */

2017-07-03T17:58:13Z

Week 4 (June 20-June 26)

← Older revision		Revision as of 17:58, 3 July 2017
Line 110:		Line 110:
	'''Tasks Completed :'''		'''Tasks Completed :'''
	<pre>		<pre>
	* Fix ElasticSearch Bug ~~(In Progress!)~~		* Fix ElasticSearch Bug
			* Completed Backend-Frontend Integration
			* Website setup and made available for developers
	</pre>		</pre>