search

prmr / Creco

Recommendation System for Consumer Products
Apache License 2.0
6 stars 2 forks source link

Document the architecture #7

Closed enewe101 closed 10 years ago

enewe101 commented 10 years ago

Diagram the overall architecture and flow of activities. I might try to bust out some UML on this.

This should be a living document that represents the actual relationships that we are building. If something seems out of line with what you're building, it's a sign that a discussion needs to happen. Hopefully this will help keep us well-synced.

asutcl commented 10 years ago

Do you need help with this Edward because I think a working copy of this is needed ASAP. Even if it is not perfect.

enewe101 commented 10 years ago

Yeah, actually. I put a bunch of time in trying to get the data API done, and I need to do some homework now :) Do you want to do the first draft?

asutcl commented 10 years ago

No problem! I will work on a first draft this afternoon.

asutcl commented 10 years ago

So I have a suggestion. I used this new tool called GenMyModel, which is currently in beta and free. It's a web based diagram maker, which can be shared with others. I've created some sort of flow chart as well as sketch of a package diagram. This sketch is basically package names and what I thought they did.

My idea was to use this tool so that everyone can create a representation of their package online so others have a quick access to what others are implementing and we can then discuss how these link together. This is diagram based so it might be easier than having to go over a lot of source code.

I will invite you all. You can log in with your github account. We may be able to link it to our github somehow.

This could be used for discussion and clearing out issues people might have. If anyone doesn't think the tool is good for us let me know.

asutcl commented 10 years ago

I've added you all through your McGill emails. If it gives you trouble connecting with your github account let me know and I will try to add you some other way.

enewe101 commented 10 years ago

Hey, that looks like a great tool to me!

asutcl commented 10 years ago

Edward, I wasn't able to see the test you sent me since I think it's linked through my mcgill account and by default I connect with my gmail/github account. Were you able to see what I posted? If not I will get eveyone's github email on Tuesday.

enewe101 commented 10 years ago

Hmm, I also couldn't see yours. Maybe something wrong with sharing. My github email is my personal email, the one I used to send you email before. I'm not sure what diff it will make but you could try with that one?

enewe101 commented 10 years ago

I can see yours now :)