Improvements to the "Local Development" documentation

[robotichead]

https://nearbeach.readthedocs.io/en/latest/002-local-development-environment-setup/index.html

Currently the documentation is missing vital information, and will need to be updated so users can easily setup NearBeach locally.

[ultralegendary]

Hi, I would like to contribute to this. Can you assign this to me.

[ultralegendary]

hi @robotichead ,
I have restructured the documentation. Can you review this and let me know if this looks good?

Can you shed some light around this topics so that I can get clarity and know what I have missed.

• Do we dont need to add Database and Blob storage setup? They are mentioned in the Docker setup, so the doubt.
• Do you have a list of things that needs to be added, or a list of things for which the users have faced issues.
• I am not sure about the use of NPM here. I was not able to find any reference on its funcitionality for this project. As I completed the python setup, I was able to access the server, so it would be nice if you could provide me some reference around the use of NPM/JS. 😄

Thanks

[robotichead]

Hey @ultralegendary ,

Thank you very much for this. :D

Do we dont need to add Database and Blob storage setup? They are mentioned in the Docker setup, so the doubt.

The database will be SQLite for any local environments. Setting up a development database for your local environment I would say is very optional.

As for the blob storage, this is something I have missed in the documentation. It might be an idea to tell the user that this is an optional step if they want to enable uploads/downloads

Do you have a list of things that needs to be added, or a list of things for which the users have faced issues.

At the moment, I am up for any recommendations on what is missing and what is needed. A fresh pair of eyes will definitely help.

I am not sure about the use of NPM here.

That is fine :D Luckily the setup of the npm is really simple :)

Once again, thank you. We have merged in your changes.