Difference between revisions of "Online Geometry Viewer Back-end"

From BRL-CAD
m
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
Online geometry viewer (OGV) is aimed to enable users to view BRL-CAD's geometry files (.g files) on browser. Development started in 2013, efforts were made to make it
+
<h1> <strong> Online Geometry viewer for GSOC - 2018 </strong> </h1>
−
functional and no doubt it is working but lacks robust infrastructure.
 
  
−
Development of OGV's back-end basically involves the basic infrastructure that includes rebuilding the whole project using some web application framework and adding new features. Rebuilding includes the basic part i.e. visualizing the geometry on browser (.g to .obj conversion and then read .obj in ThreeJS), sign-in sign-up module etc. You can leave the GUI aspect of this project for now as it is another sub project under OGV.
+
<h2> <b> Scope for GSoC 2018 </b> </h2>
 +
We have been working on OGV for 5 years. It started with PHP and then was revamped to meteor.js (before it was cool). This year we want to focus on the backend of OGV, making sure it works properly, converts the models properly and basically finishing a version of OGV and launching it for the masses. So it's going to be a really exciting summer this year. We have arranged a list of features, bugs, and enhancements that we think should be handled this year and have put them (https://github.com/BRL-CAD/OGV-meteor/projects/1?fullscreen=true) here on github.   These issues are arranged via priority, so you will get an idea about what you can include in your proposal for this summer.
  
−
Use of a full stack framework for back-end development would be desirable.
+
<h2> <b> Checklist to write proposal for OGV </b> </h2>
  
−
New features primarily includes user dashboard, file management, file
+
* Download and clone OGV from https://github.com/BRL-CAD/OGV-meteor
−
sharing with other users, conversion to other CAD formats etc. Check references for more details. If you have better idea regarding anything feel free to discuss at IRC or mailing list.
+
* Run OGV on your local. Can you find some steps missing in Readme?
−
 
+
* Fork OGV repo
−
=References=
+
* Choose a couple of <b> low hanging </b> issues, solve then and send a pull request. More PRs equal better chances of selection!
−
* Current implementation: [[Online_Geometry|Online Geometry Viewer]]
+
* <b> Talk to mentors about your PR </b>
−
* Desired features: [[Online_Geometry/TODO|TODO]]
+
* Choose list of issues that you would like to solve this summer
−
 
+
* Make sure it contains as many(https://github.com/BRL-CAD/OGV-meteor/projects/1?fullscreen=true) high priority issues as possible.  
−
=Requirements=
+
* Did you find a bug? Do you think there's a feature that's really important but it's not here? Feel free to add it to your proposal.
−
* Familiarity with web development technologies(HTML, PHP, JavaScript etc).
+
* Make a detailed weekly plan for your summer. More detailed, the better. Include why, what and how whenever you can.
 +
* <b> Share your proposal with your mentors </b>
 +
* Make any changes if required
 +
* Put the proposal on BRL-CAD wiki
 +
* <b> Talk about your proposal with your mentors. Get feedback. </b>
 +
* Submit it to Google Summer of Code website.

Latest revision as of 15:21, 24 February 2018

Online Geometry viewer for GSOC - 2018

Scope for GSoC 2018

We have been working on OGV for 5 years. It started with PHP and then was revamped to meteor.js (before it was cool). This year we want to focus on the backend of OGV, making sure it works properly, converts the models properly and basically finishing a version of OGV and launching it for the masses. So it's going to be a really exciting summer this year. We have arranged a list of features, bugs, and enhancements that we think should be handled this year and have put them (https://github.com/BRL-CAD/OGV-meteor/projects/1?fullscreen=true) here on github. These issues are arranged via priority, so you will get an idea about what you can include in your proposal for this summer.

Checklist to write proposal for OGV

  • Download and clone OGV from https://github.com/BRL-CAD/OGV-meteor
  • Run OGV on your local. Can you find some steps missing in Readme?
  • Fork OGV repo
  • Choose a couple of low hanging issues, solve then and send a pull request. More PRs equal better chances of selection!
  • Talk to mentors about your PR
  • Choose list of issues that you would like to solve this summer
  • Make sure it contains as many(https://github.com/BRL-CAD/OGV-meteor/projects/1?fullscreen=true) high priority issues as possible.
  • Did you find a bug? Do you think there's a feature that's really important but it's not here? Feel free to add it to your proposal.
  • Make a detailed weekly plan for your summer. More detailed, the better. Include why, what and how whenever you can.
  • Share your proposal with your mentors
  • Make any changes if required
  • Put the proposal on BRL-CAD wiki
  • Talk about your proposal with your mentors. Get feedback.
  • Submit it to Google Summer of Code website.
Retrieved from "https://brlcad.org/w/index.php?title=Online_Geometry_Viewer_Back-end&oldid=10502"