search

pdrbrnd / whatsinthebox

7 days of the best movies in Portuguese TV
https://whatsinthebox.tv
GNU General Public License v3.0
26 stars 1 forks source link

README.md lacks information #10

Open IvoPereira opened 3 years ago

IvoPereira commented 3 years ago

Description:

After publishing the project in the devPT Challenge I have come to the same conclusion of some posted comments.

The README.md is missing some important information like the project concept, perhaps tech stack, technical decisions and how to contribute to the project (for newcomers). It is as well unclear how to replicate the Hasura+DB in a local/staging environment.

_Para contexto, este issue foi criado no âmbito do Challenge devPT - https://www.reddit.com/r/devpt/comments/pmeuh5/challenge_devpt_1/._

pdrbrnd commented 3 years ago

I agree.

Initially, this project was made to solve a personal problem of mine and it wasn't supposed to be open source. Looking back, making it public was perhaps a bit rushed and the README.md definitely needs some work.

That being said – and probably something that should be revised – you shouldn't have to replicate the Hasura + DB locally to run and contribute to this project: currently it only has one production instance that's used for production and can be used for local development as the main purpose of this repo is just to consume that data.

With this in mind, maybe it wouldn't be a bad idea to further separate the concerns and move the api/admin/* routes to a separate repo

pdrbrnd commented 3 years ago

I have a private repo for the hasura actions, metadata, etc. maybe a monorepo approach would make sense for this project so anyone could quickly run a local instance of the DB