katleiahramos / bark-park Goto Github PK

Current the router is a """bit""" messy. There's a mix of using rails resources and HTTP verbs and actions.

To be more explicit and for better user readability, replace the resources with HTTP verb and path.

example:

This may require looking at the checkins and parks controllers to see what routes and controller methods are currently being used.

Tasks

• replace resources for checkins and parks with HTPP verb and path syntax.
• ensure API calls work as expected, and that the UI still functions as expected.
• (BONUS) add simple unit tests for those endpoints

Resources

https://guides.rubyonrails.org/routing.html

Tasks:

• add a PR template to the repo!

Resources:

"how-to"
https://help.github.com/en/articles/creating-a-pull-request-template-for-your-repository

Examples
https://github.com/devspace/awesome-github-templates
https://github.com/stevemao/github-issue-templates/

I'm super open any/all suggestions on the design of this app! whether thats colors, suggestions for a design system/style guide, or small updates to the existing design.

We can start the conversation here! Feel free to leave comments to contribute to the overall conversation, and/or if you have ideas and would like to be directly involved I would love to chat about where we can document that process/hold the information.

Right now the JWT encoding and decoding happens in the application controller, and the JWT secret is hard coded into the code (see link below)

Tasks

• use an environment variable to get the JWT secret value, replacing the hard coded value.

Resources:

• example of use of environment variable here:
  

  Bark-Park/client/src/containers/MapContainer.js

  Line 93 in 39a63d8

  apiKey: `${process.env.REACT_APP_GOOGLE_MAPS_API_KEY}`

• project is currently using dotenv for handing of environment variables (https://medium.com/@danieljameskay/create-react-app-dotenv-281693a19ecd)

The Logo is too close to the end of the nav bar. Change this spacing to be 16px

As more people add contributions, it would be great to have a file with more informations (even FAQs on how to contribute)

Tasks

• add a contributing.md file to the repository

Resources

Example:

• https://github.com/codebuddies/codebuddies/blob/master/contributing.md

Currently in the README there is a gif (or different image type?) that's not working. See below:

Tasks

Remove broken image from the README to give it a cleaner look.

Current Behavior

• Currently, the app is over flowing horizontally and scrolling to the right. See gif below.

Expected Behavior

• the app does not overflow and there is no ability to scroll horizontally

Current Behavior

Expected Behavior

As you reduce the number of parks, the layout of the page stages the same (the state of the page layout when there are 6 parks).

At the moment, the login form does not validate against empty fields for username and password.

Acceptance Criteria for this tasks:
As a user, I should not be able to submit the form without entering a username and password and I should be notified in the UI why I cannot submit.

Add some space between the close button and the right side of the modal. Spacing should be 16px between the button and the right side of the modal.

Current Behavior

Currently, when if a user is checked into a park and they refresh the page, the UI does not represent that they are currently logged in.

see below

Expected Behavior:

When a user refreshes, the UI is still in the checked-in state.

Note:

• this may take some involved debugging, and be a more complex task to fix.

The styling on the close button is not the same for create and edit park.

New Park:

Edit Park:

I'll leave it up to your creative choice on what the styling should be (as long as they're consistent).

Add more space between the password field and the back and submit buttons. Ideally the space between them should be 32px.

After #16 is merged, it would be great to address the TODO to add the Pull Request Process. Since this is after the Development section that should describe the process for forking the repo, cloning it locally - we this section should probably include information about how to create a pull request and what to expect. For example: use the pull request template, # of reviewers required (maybe some reasoning behind that).

Tasks

• add documentation in the TODO under the Pull Request Process header

Add a section to the contributing doc contributing.md

Pick any format you'd like as long as it includes the contributor's name.

Oh, and of course add yourself to that as part of this PR!

I would really love to make this project more open-source and developer friendly.

Right now the the README doesn't include any notes about how a developer can pull down the code locally and get it up and running.

Task

• Update README to include installation instructions (downloading dependencies like postgresql, node, ruby, rails, ect)