Documentation Request

[shegz101]

I would love to contribute by writing proper documentation for this project. And if there is an existing one, I would love to help update or improve it. Thanks.

[goenning]

Hey @shegz101 I'm still unsure where to go with documentation for this project. One place we could start is with a developer's documentation on how to get started with local development, requirements, etc. I think some projects use the CONTRIBUTING.md file for that. What do you think?

[shegz101]

Sure, that's a good approach.

[shegz101]

Hello @goenning, please let me know when you want to create the documentation. Thanks.

[goenning]

Whenever you have time :)

[shegz101]

Alright, I presently have some things to clear up. Should be back in 3 - 4 days from now. Thanks.

[shegz101]

Hello @goenning

[shegz101]

@goenning When you are up let us discuss on how to go about the docs. We could probably do a proper call (Google Meet). Let me know what you feel.

[Robert27]

Any updates on this?
A Contributing documentation with instructions on how to setup the local development environment would be really helpful since I would like to contribute to the project.

I managed to build the dockerfile and get it up running, but now I’m stuck at the registration link not getting generated.

[goenning]

I’ll try to add one tomorrow

[goenning]

@Robert27 can you give it a try https://github.com/aptabase/aptabase/blob/main/CONTRIBUTING.md ?

Using this setup, the app will use the Mailcatcher docker instance to send emails, so you can get the link from the UI

[Robert27]

Thanks, I followed your steps and got every up and running.