Giter VIP home page Giter VIP logo

eloc's Introduction

eloc

Elephant Localization

eloc's People

Contributors

chamathsilva avatar charithccmc avatar namaljayasuriya avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

eloc's Issues

Module issue

One issue I found was that there seemed to be no module named "mpld3".

I downloaded all the content from eloc. Then in the server.py, it said that it was missing a module called "mpld3". I downloaded mpld3 from github, and it sensed the file, but still said "No module named mpld3". I looked for a pip install, and installed it, but it still said "No module named mpld3".

I think that GCI should put where to get these modules from, and the Readme.md didn't have any proper information. It was also missing some important files like config files.

screen shot 2018-10-27 at 1 21 19 am

Repo should follow GitFlow Workflow

This repos should follow Gitflow workflow and follow are the items you have to check. 
- [ ] There is a `master` branch and a `develop` branch.
- [ ] `master` branch is locked for direct commits and, 
  - [ ] Require pull request reviews before merging is active
  - [ ] Require status checks to pass before merging is active
    - [ ] Require branches to be up to date before merging
    - [ ] Appropriate Status checks are required
  - [ ] Enforce all configured restrictions for administrators is active
  - [ ] Restrict only maintainers group can push to the master branch
- [ ] `develop` branch is locked for direct commits and,
  - [ ] Require pull request reviews before merging
    - [ ] Dismiss stale pull request approvals when new commits are pushed is active
  - [ ] Require pull request reviews before merging is active
  - [ ] Require status checks to pass before merging is active
    - [ ] Require branches to be up to date before merging
    - [ ] Appropriate Status checks are required
  - [ ] Enforce all configured restrictions for administrators is active
  - [ ] Restrict only maintainers group can push to the master branch

Eloc does not build due to mpld3

The local server of eloc does not startup due to matplotlib.pyplot being imported as mpld3. Initially, I thought I could come overcome this by looking around but then I noticed that mpld3 is redundant as it was not being used anywhere inside plotSpec.py.

So I removed mpld3 and rebuilt. This time, a local instance of eloc spun up smoothly. I recreated the exact error and took a screenshot for more clarity.

eloc

eloc 2

Find this task on my website: http://itsrohan.com/gci/gcitasks

Important Files are missing

Some of the Important Files that must be included in an Open Source Project are missing

Contributor Documentation
Issue Template
Pull Request Template
Proper Readme File
Build Testings Used
Config Files
Updated License
Updated Documentation

Improvements & Issues

=> Dismiss stale pull request approvals when new commits are pushed is active
=>Require status checks to pass before merging is active
=>Readme files should be more descriptive and instructions should be clear
=>Sometimes the app crashes due to mpld3
=>many syntax errors in js,css files

Major Improvements Required

The program doesn't support Python 3. Since it's been a long time since Python 3's launch 98% people has switched to Python 3. Also all the New comers will have learnt Python 3. So it's best that the program is written in Python 3.

README.md needs to be more descriptive

This project's README.md is not explained well enough about the project itself. A few pros about the project, explaining what the project actually does and stating methods of using it would be really helpful.

It can rather start as....

"This project is used to locate the geographical locations of elephants. ELOC can be setup by doing the following steps.... etc.

Making it more descriptive would surely help people understand it much better, including newbies.

[GCI2018] No Guide How to setup or how to use , no requirements.txt , not Python 3 Compatible

Issue 1:

There should be a proper guide on how to set up a development environment, or how the users going to use it.
How the users are supposed to know how the program works.

Possible Fix: Add Proper Guide

Issue 2:

There must be a requirements.txt file on each folder which contains libraries other than the Standard Libraries.
eloc_node, eloc_server folders must have requirements.txt file on each folder.

Possible Fix: Add requirements.txt file on above-mentioned folders

Issue 3:

As the life of Python 2.7 is about to end, it would be better to use Python 3 instead.

Possible Fix :

  • Rewrite in Python 3 or make it Python 3 compatible
  • use 2to3 tool

Issue 4:

eloc_node/readData.py file has inconsistent use of tabs and spaces in indentation.

Possible Fix: Use 4 soft spaces instead of tabs

Need more details on README

The new contributors will get the idea of the project after reading the readme file. But here the only thing that consist in the readme file is "eloc". So I suggest to add details to the README file

No Travis CI Support Available

image

Expected Behavior

There should be Travis CI Integration In Project Which runs tests every time Anyone commits to Repository.

Current Behavior

There is no Travis CI Integration Available

Possible Solution

All the commands/Documentation that are required To integrate Travis CI are present Here

Follow-up

Update the README.md accordingly.

Google Code-In 2017: Getting Started Issue

THIS IS A NOT A REAL ISSUE BUT A PLACEHOLDER.

All the practising PRs for Google Code-In 2017 should refer this issue. PRs referring this issue will be closed without merging. Do not refer this issue if you are NOT submitting a practice PR and need your work merged.

About and Home Links show Endless Loading

The "About" link on the initial pointing to pages/about.html and "Home" link pointing to pages/dashBoard.html are not loading the respective pages and show endless loading animation

Several improvements.

  1. Batch should be made with a inbuilt environment installed especially for Python GUI Bash
  2. There should options for several Languages other than English.
  3. There should be some kind of Page build up for Tabs like FAQ's and tab to ask Questions to people.
  4. At line 13, SYSTEM_RATE can be increased to '800' to get a better connectivity with the apparent IP
    Address.
  5. Also, Font Style tab may be added for more fancy touch to the Python Bash GUI.

README.md needs Proper improvements

There are several directories where readme update is neessary like eloc_node,eloc_server only python script is provided respective README.md is blank.

[GCI-2018] Lack of information and guides

There is very less info in README and no proper ISSUE SUBMITTING TEMPLATE is there.

  • There should be a proper guide on how to set up a development environment, or how the users going to use it.

  • There must be a requirements.txt file on each folder which contains libraries other than the Standard Libraries.

  • The program doesn't support Python 3. Since it's been a long time since Python 3's launch 98% people has switched to Python 3.

readData.py issue

readData.py found under eloc_node file:

Inconsistent use of tabs and spaces in indentation

image

No idea what eloc_data contains.

Eloc_data should have more descriptive inside catalogs names, because now we have weird naming, and don't know how this data is relevant to project.

README.md needs to be improved

I wasn't able to install it because there's lack of information on the README.md in such a way that you don't know what this thing does or how to install it. It needs improvement :D

README.md should contain images

the README.md file should contain images of the project and installation process, images play a very important roll in an Open-Source project not only because it shows you some ui components for example, and you can get feedback to improve your project UI without needing to install, or sometimes images help a lot when someone has problems installing for example terminal output screenshots.
Hope this helped :D

README file should have setup steps

README.md file should explain how to set up the project locally, on the user's own environment. We should describe how the installation process will look on Linux (Ubuntu etc.), Mac and Windows.

This process is for sure easy and fast, but some people coming from another environment or those who are not very familiar with git itself wouldn't be able to set up eloc.

This Issue is connected with #5 as this file has no description AT ALL ๐Ÿ˜ž

Issues and files that are missing

The local server of eloc crashes due to mpld3.
the README file should be more descriptive for the user in order to follow instructions
And important files such as ,contributor documents and config files are missing.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.