search

Eptikar-IT-Solutions / openngo

OpenNGO is a platform to help NGOs better help the world!
Apache License 2.0
8 stars 3 forks source link

Add Documentation #2

Open 3ammari opened 8 years ago

3ammari commented 8 years ago

I've been trying to see what i can do about the issue you posted but soon found my self kind of lost and not a single line of documentation was present so is there any documentation for the project ?

nimir commented 8 years ago

Hi @3ammari

First of all, thank you very much for the interest in contributing to OpenNGO.

About documentation, the type of documentation we plan to write is more like a user-guide documentation for features listing and general usage of OpenNGO, we also feel a training-guide documentation will be needed soon to help volunteering trainers.

For the type i think you refer to: a technical-documentation honestly we didn't plant to write it now! as we barely have a typical Rails application following typical MVC pattern. no fancy methods or lib plus the project still under heavy development with many parts that could be replaced or re-written completely.

But for now let's try going back to #1 ... How about you tell us more about where you struggled? is it in running the app locally? during db setup? when writing the model method for Trello integration? For each we are 100% willing to help.

During working with you on #1 if the lack of the technical-documentation turned to be a setback for contributors we will definitely come back to this one and start writing it :muscle: , deal?

3ammari commented 8 years ago

Thanks for the fast response well i managed running the app locally but could not log in neither register ,i thought it something related to the mail server configuration since it i gives me an error of 554 5.7.1 Net::SMTPFatalError , but when i went to check the demo version you provided on Heroku's platform , something was also broken and it gave 500, i wanted to see the normal flow but couldn't

nimir commented 8 years ago

The signup - register flow won't work on your local machine without a mail configuration. As for the issue on the demo on Heroku we will look into that.

It's great you have a version running locally now, so to get a feeling of the application on your local machine you could run the db seed using the command rake db:seed and use the default user credentials to login https://github.com/Eptikar-IT-Solutions/openngo/blob/master/db/seeds.rb#L13