pdariusv / howdy-group-project Goto Github PK

The problem

Having 2 branches is confusing and complicated for beginners and when they make changes against master by mistake they inevitably have to go back and do some fiddling (although the sadistic part of me enjoys putting new developers through trial by fire merge conflict). Add on top of that the fact that we don't use the workflow of master == production develop == dev-env means we just have the pain without the benefit.

The solution

The options I see:

1. Remove develop, just use master.
2. Make develop the default branch.
3. Better documentation (#23), the devs will learn...

State defined in client/src/App.js does not belong there. See thinking in react, and skip ahead to step 4 to see what I'm talking about (you can/should also read the whole thing). State and its handlers should be defined at the parent of components that use it. How can we split the state? Let's advance the discussion in the comments.

We could add a linter to the project to allow devs to check their style consistency via an npm script.

README.md should clarify that we work from develop branch and outline the steps to launch full dev env. Comment if you want to be assigned this issue :)

Right now the db name is posts. It's a bit confusing. The db name should reflect the app name. A change in src/server.js line 15 should do it, but you should inspect the db to make sure all is ok. Comment to get assigned or ask questions

The README.md file should be updated to include more information about the project such what it does, how to set up a dev environment, etc.
#2

While this does not break the app, developers should have clean console output.

Comment and I'll help or assign you

Our init script does not work the way we want.
Currently, src/init.server.js makes requests to localhost:3000 but it should use mongoose to add demo.db.js data through the Post model.
Those two files should also be in a separate directory at the root folder, db/. We can rename the files src/demo.db.js -> db/data.js and src/init.server.js -> db/init.js.
Finally we should have an npm script called db:init that runs db/init.js.

Right now the title is React App, should be Howdy Forum. Description is Web site created using create-react-app should be Forum by the Howdy community, for the Howdy community.. Can be changed in client/public/index.html. Comment to be assigned or to get help.

The body of the app seems to be wrapped in a card (see borders). Looks like the culprit is the Paper element in CombinedPanels

That looks a bit wonky. Would be better if uniform.

We should have a contribution guide, like a CONTRIBUTING.md that will allow the community to make contributions independently, to the extent they can. That should include a very simple fork and branch explanation (but not teaching git from scratch, maybe direct them for further reading) and a link to the slack and group video (with the schedule).
Comment to get assigned or with extra ideas/questions.

In client/src/components/Dialogs/PostReply.js the two buttons currently render but are disabled if you are not the author. They should not render at all if you are not the author.

In post details

Our client/.gitignore used to be the ignore file of the backend. Now the client's .gitignore contains unncessary lines and the server .gitignore is missing some (like /data/db). There may be other files that need to be ignored but I can't think of any now. Comment to be assigned, ask questions, or suggest other files to ignore.

Dangling closing tag in client/src/components/Forum/Post.js line 68 causes issue in render, like so:

Comment if you want to be assigned this or if you have questions.

We should be using data from the backend in client/src/components.App.js. Right now it comes from a static file: client/src/data/store.js. Delete that file and all references to it. We should only have the data from the fetch request to the backend. Make sure it works with post data from db. May need to wait for #33 fix.

Typography component is used throughout the client code but I'm pretty sure it's not used in the way it was intended. It should either be removed or replaced with something more semantically meaningful. Comment to be assigned this issue or if you have questions.

Forum by the Howdy community, for the Howdy community

I think this will give the project a clearer direction and possibly attract more contributions.

Right now our posts are a static object on the front-end. Create a route to fetch the posts from mongo and call that endpoint from the client to get the posts. Comment to get assigned or ask questions. Don't be intimidated by the "difficulty:hard" label, I'll help in any way I can. This may also need to be broken down to several issues/PRs.