Improve documentation for developing the client

regner / albiondata-client

Distributed client for the Albion Data project.

https://albion-data.com/

MIT License

38 stars 17 forks source link

Improve documentation for developing the client #3

Open regner opened 7 years ago

regner commented 7 years ago

There should be good documentation for developing the albionmarket-client. i personally do the client development on a Mac laptop so can provide documentation for that, however documentation for getting the windows development working will be tougher.

NullSoldier commented 7 years ago

I'd like to contribute to the project so I may contribute to this one as I get set up. Is the actual market website also on github? That is probably where the most interesting work to contribute to is.

My question is where is the server hosted that the API data gets shipped off too? I would like to make an independent open source broker to host the data that other services can register hooks for, or query via a REST api. Do you feel like your current server fits that requirement?

regner commented 7 years ago

@NullSoldier Thank you very much for your interest in contributing to the project. There are 3 major components to the project. The client here, the backend (https://github.com/Regner/albionmarket-backend) and the frontend (https://github.com/Regner/albionmarket-frontend).

The backend is a Python Flask application that offers an open API that anyone can make requests to. The frontend is a VueJS application that consumes the same API from the backend that anyone else can pull from.

I would very much like to see one major ingest point for everyone. That way we get as much data as possible and everyone benefits. To that end I have tried to keep everything as open as possible to encourage that. I am happy to reconsider the architecture of the backend or make major changes if needed.

Let me know if you have any thoughts on that and feel free to open issues on those projects to discuss them.

Again, thanks for your interest in contributing! :D

NullSoldier commented 7 years ago

As long as you have the market JSON, I think most of the contributions that are interesting will be in the backend, as well as the frontend. I wish you chose react / django but I'm just happy that you've made it open source! Here's my list of features I'm going to look into contributing. I haven't checked what is supported or already done yet.

Donate enough accounts to run clients in every game city and run them in VMs on Azure
Historical graphs for prices of resources (save off a copy of the model of each resource when JSON is sent up), also implement front end
Most of the market optimization tools that elite dangerous has here, https://eddb.io/ such as (best place to transport your current resources to make the most money), round trip transport for resources to make money
Inflation rate calculator by looking at an index of the most commonly used resources

I'll jump into the code this week.

regner commented 7 years ago

All of that sounds awesome! Please feel free to hit me up here or if you're in the Albion Online Discord I go by Regner there as well.

One of the things I think is going to have to change in the backend for the ingest is offloading the actual saving of information. Probably best to take an ingest request, dump it into a queue, and then process the queue async. Right now the whole request is held up while 50 orders are looked up and saved individually.

If you do work on the backend you can use the pre-built client and start it with the -i CLI flag to give it a different ingest URL. Allows you to develop the backend that is Python without having to build the Golang application from source.