search

MintbeanHackathons / MintbeanPlatform

This is what powers https://mintbean.io
GNU Affero General Public License v3.0
24 stars 15 forks source link

Create a backend README.md #13

Closed monarchwadia closed 4 years ago

monarchwadia commented 4 years ago

We need instructions on getting started EDIT: This is for creating getting-started instructions for the backend project, only

Sumedh-Patkar commented 4 years ago

I wasn't suggesting a README exactly.

We can't put everything in the README. Let's say tomorrow the project becomes huge, then readme will become too clumsy.

Can we have a 'how to contribute' documentation on a platform like https://readthedocs.org/ ?

The documentation will contain everything from setting up the development environment to visual guidelines

Have a look at this example - https://docs.aiohttp.org/en/stable/contributing.html

Your thoughts?

AzaniaBG commented 4 years ago

I can work on this. I just need to know if there is any information that I need to reference and where I can find it.

monarchwadia commented 4 years ago

@Sumedh-Patkar those are excellent points. For a project of this size, maintaining documentation on the Github itself is a lightweight way to get started.

Eventually, once we need it, we absolutely should get hosted docs -- for now though, i think we can run with what Github gives us.

monarchwadia commented 4 years ago

@AzaniaBG you can get started by creating a README for how to get the backend started.

AzaniaBG commented 4 years ago

@carloshdelreal will be handling this