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

[FEATURE Clarify README's regarding frontend or backend instructions #262

Closed
ErikaVasNormandy opened this issue Sep 23, 2022 · 2 comments
Closed

Comments

@ErikaVasNormandy
Copy link

Is your feature request related to a problem? Please describe.
Currently, there are two README's, one focused on the backend, and the other focused on the frontend

Describe the solution you'd like
Mention at the top of the initial README that first time users encounter, where to go if they would like to run the frontend or backend.

Additional context
This was based on just a cursory glance on the starting out instructions, assuming that first time users will be unfamiliar with the project structure and to anticipate any confusion/troubleshooting that may arise

@caseydulong
Copy link
Contributor

I'm going to take a look at this tonight.

@caseydulong
Copy link
Contributor

caseydulong commented Sep 28, 2022

After chatting with Erika and Darrell, I made some very small changes to the root README, and the frontend README. Made sure the two sets of instructions link to each other to help newcomers find their way through the setup more easily. I'll make a PR for the small changes now.

Edit: Pull Request

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants