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

Clean Up READMEs #80

Open
2 of 9 tasks
dcardona23 opened this issue Feb 7, 2025 · 0 comments
Open
2 of 9 tasks

Clean Up READMEs #80

dcardona23 opened this issue Feb 7, 2025 · 0 comments
Assignees

Comments

@dcardona23
Copy link
Collaborator

dcardona23 commented Feb 7, 2025

BE README

  • Correct order of database setup - Postgres user needs to be installed before rails db:create, migrate, seed
  • "Contributing" heading should be changed to "Contributors"
  • Instructions to avoid "error": "Not authenticated" when viewing user data (dashboard, job apps, contacts, companies, etc.)
  • Instructions to see admin-level end-points like Get All Users

FE README

  • Add link to deployed site/app
  • Correct CircleCI setup instructions
  • Remove reference to getting a free API Key at "https://example.com" from installation instructions
  • Improve organization of design doc (subheadings would help more easily identify styling requirements - examples below)
  • Improve readability of Global Context description and implementation

Styling

Font

Helvetica Neue Sans-Serif

Icons

MUI's SvgIcon icons

Form Container

<div className="w-[50vw] mx-auto my-[2vh] p-[3vh] ">

Save Button

<div bg-cyan-600 text-white px-[2vw] py-[1vh] rounded w-[10vw] hover:bg-cyan-700 focus:ring-cyan-500 focus:ring-2>

Form Boxes

<label htmlFor="email" className="block text-gray-700 font-medium mb-[1vh]"> Email </label> <input className="w-full px-[1vh] py-[1vh] border border-gray-300 rounded-md focus:outline-none focus:ring-2 focus:ring-cyan-500" name="email"/>

@dcardona23 dcardona23 moved this to Backlog in Tracker CRM Feb 7, 2025
@sethverrill sethverrill moved this from Backlog to In Progress in Tracker CRM Feb 14, 2025
@sethverrill sethverrill self-assigned this Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

No branches or pull requests

2 participants