search

apihlaja / node-irsdk

iRacing SDK implementation for Node.js.
https://apihlaja.github.io/node-irsdk
MIT License
102 stars 55 forks source link

Developer support #79

Open iamisti opened 5 years ago

iamisti commented 5 years ago

Hi there!

I'm very extremely happy to have this package open sourced. It would be great if we developers could contribute to your project, but unfortunately there is no description about how to set up a development environment, and how to compile everything to check if things are working properly.

For example I'm having problems with node version, because in some c headers there is still the old node reference and so it cannot be used with other version of nodes.

Would be great if you can extend the readme for some developer support! I'd love to join and help you out.

joshystuart commented 4 years ago

@iamisti et al; I would be keen to help as well.

On a side note: I was already contemplating either writing a TS declaration file OR converting this project completely to TS. I think long term there is benefit in that, as many big projects are making the switch, so the tools are getting better, and a lot more people use TS as a starting point.

I dont think that would be a pointless refactor as it really helps integrate the library into your own project without having to read lots of doc.

Would anyone be interested in that?

rators commented 4 years ago

@crimsonronin going to fork this project and write the TS bindings. Working on a dashboard app using this sdk. if you make the fork I can contribute to your fork if that works.

joshystuart commented 4 years ago

Sounds good @rators! Have you started either the dashboard or the bindings yet?

sabifa commented 4 years ago

Not sure if you guys already started on the typescript things but here is my declaration file: https://gist.github.com/sabifa/d64c38a996304bd72f3af90564724d43

I'm sure there are things missing, I'm just starting out with typescript but so far it works as expected for my projects using the package! 😅

joshystuart commented 4 years ago

Nice one @sabifa !

I haven't had time to do anything related to this unfortunately. But I'm keen to try out your bindings. Maybe you could even make a package out of it so we can consume it and contribute back via PRs?

sabifa commented 4 years ago

Yes that would make sense, but where would I put this package? It would be nice to include it directly with this repo, but it seems like the maintainer is quite busy at the moment and can't spend much time on it. Maybe here?