Hacker News new | ask | show | jobs
by akx 2770 days ago
This is not the sort of repo I would present to the public.

* There are no instructions on how to actually run the thing.

* There is no requirements.txt or similar, so I have no idea which version of dependencies I'd need.

* The repository is strewn with unnecessary files (.pyc/.ds_store/.so...), random-looking images with names like "plswork.png", a HTML file from some "starter kit"...

* I can't seem to find the React frontend that is mentioned in the readme -- on the other hand, it looks like `server2.py` is looking for them outside the repository (`".././reactExperiments"`).

4 comments

Hello ! Thank you for your comments, it is true that this repository is not in ideal shape. I shall work on making this much more user friendly by tomorrow. I had no idea that this would be seen by this many people. The react frontend is currently not in this repo, I shall add that along with documentation soon :) Thank you for your comments and your review.
> This is not a prodution worthy piece of software,it is only meant for demo purposes

It's a pretty cool proof of concept ;) Go easy!

From the readme,

"This is not a prodution worthy piece of software,it is only meant for demo purposes"

It’s not that the code is not production ready. It’s more about first impressions. There are some really fundamental issues with the presentation. The first thing you do when starting a new git repo is create your .gitignore.

I’m also not a Pythonista and I’ve only been working with Python for about a year, but including required packages in the requirements.txt is like Python 102.

I think it's probably best to interpret it as something like a blog post presenting an idea than an actual usable project, and maybe in its current state it should have just been a blog post.

Certainly there's a lot to be improved in terms of git hygiene and publishing an easy-to-try-out project, but it seems a bit excessive to say that the author shouldn't have posted it at all.

Stop. Just because you refuse to do basic troubleshooting doesn't mean this person shouldn't have showed it off.
I agree with the GP's points, if not its tone. Some basic instructions would really help anyone try this out, and the creator's the best person to write them down.

And it seems the creator plans to do just that. So, kudos.

Just fixed it for 15 minutes but it is still far from running, I would rather wait until project instructions are added.
Hello, thank you for your interest ! I have fixed the repo structure and added instructions on how to build and run. Hopefully that is fine, if not please tell me about it and I shall update it as soon as possible.
Thank you for fixing, I think it's close. Now, flask says "index.html" is missing :-) also step 2 should have "pip3 install -r" instead of "python3 -r".
Ah yes, I'm at work now. I'll fix that as soon as I get back, though that will probably be after a few hours.
done :)