Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

simplify readme for markers #371

Closed
wants to merge 1 commit into from
Closed

simplify readme for markers #371

wants to merge 1 commit into from

Conversation

arnard76
Copy link
Contributor

@arnard76 arnard76 commented Jun 1, 2024

Markers don't have to setup frontend and backend separately to run the app locally so simplified the steps for them.

Also, removed duplicated sections of frontend and backend readme from the main readme. otherwise future maintainers will have to update in two places instead of one.

https://github.com/uoa-compsci399-s1-2024/capstone-project-2024-s1-team-15/blob/691c4b7a86e9206b447b5a93ef7da9df60256a6c/README.md

@arnard76 arnard76 added the type: docs an issue that involves the documentation label Jun 1, 2024
@arnard76 arnard76 requested a review from HuzzNZ June 1, 2024 02:25
@arnard76 arnard76 self-assigned this Jun 1, 2024
@arnard76 arnard76 linked an issue Jun 1, 2024 that may be closed by this pull request
@HuzzNZ
Copy link
Contributor

HuzzNZ commented Jun 1, 2024

It's often useful to have detailed instructions in the main readme as that is the landing page of the repository.

I am for adding a simple setup option on top of the detailed setups but it's important to have both in the main readme, especially since the steps don't change often.

@arnard76
Copy link
Contributor Author

arnard76 commented Jun 1, 2024

Ok sure, future maintainers will have to update both i guess...

@HuzzNZ
Copy link
Contributor

HuzzNZ commented Jun 1, 2024

Will be closing this PR without merging as it is preferred to run the backend & frontend separately due to logging & easier facilitation of app restarts, so a simple dev script is not needed to be presented to markers.

@HuzzNZ HuzzNZ closed this Jun 1, 2024
@arnard76
Copy link
Contributor Author

arnard76 commented Jun 1, 2024

Will be closing this PR without merging as it is preferred to run the backend & frontend separately due to logging & easier facilitation of app restarts, so a simple dev script is not needed to be presented to markers.

I think it will be worse for markers having to run double the amount of commands to setup to website locally. It is not needed to show the simple dev script but it would make their lives easier as they don't really need logging or to restart the app.

Those are definitely advantages of running the backend and frontend separately but the simple dev script is an alternative, not a replacement for it as it says in the readme.

@arnard76 arnard76 reopened this Jun 1, 2024
@HuzzNZ
Copy link
Contributor

HuzzNZ commented Jun 1, 2024

Will be closing this PR without merging as it is preferred to run the backend & frontend separately due to logging & easier facilitation of app restarts, so a simple dev script is not needed to be presented to markers.

I think it will be worse for markers having to run double the amount of commands to setup to website locally. It is not needed to show the simple dev script but it would make their lives easier as they don't really need logging or to restart the app.

Those are definitely advantages of running the backend and frontend separately but the simple dev script is an alternative, not a replacement for it as it says in the readme.

The markers 100% understand the reason to run backend & frontend separately.

@arnard76
Copy link
Contributor Author

arnard76 commented Jun 1, 2024

They might understand why we should run it separately, for the reasons you mentioned. But the markers aren't developing, they probably just want to run the whole app to test it.

@arnard76
Copy link
Contributor Author

arnard76 commented Jun 1, 2024

The readme requirement for project setup was this:

Instructions on how to install and setup the project (specify all dependencies).

i figured we go for the simplest option so it doesn't take as long for the markers. If for some reason, they want to run it separately e.g. to test API endpoints then can follow the note at the bottom of the setup.

@HuzzNZ
Copy link
Contributor

HuzzNZ commented Jun 1, 2024

The readme requirement for project setup was this:

Instructions on how to install and setup the project (specify all dependencies).

i figured we go for the simplest option so it doesn't take as long for the markers. If for some reason, they want to run it separately e.g. to test API endpoints then can follow the note at the bottom of the setup.

Why would we give them a subpar option just to "save time" for the markers? They understand how to run web apps and are likely well acquainted with running webapps in a monorepo.

Why do we even care about saving time for the markers? If this is how the app is supposed to be ran, then we should only include the proper way to run the app.

I will be updating the README in cleanup to include more information, but this PR will not be merged.

@HuzzNZ HuzzNZ closed this Jun 1, 2024
@HuzzNZ HuzzNZ deleted the simplify-readme branch June 1, 2024 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs an issue that involves the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Global: Documentation
2 participants