vets-who-code/romeo-golf-cohort

Vets Who Code 🔥

Technologies used 🛠️

• HTML 🚀
• CSS 🚀
• JavaScript 🚀
• SASS 🚀

---

How To Use

Install the dependencies

Using NPM:

# Install dependencies
$ npm install

# Listen to changes in CSS Preprocessor files ( SASS files )
$ npm run compile:scss

Once you run npm run compile:scss, then open the index.html inside your favorite browser or using the live server extension.

romeo-golf-cohort's Issues

Create a PR Template

Description

As a user, I want to have a standardized form to complete when creating a PR.

Acceptance Criteria

• Add PR template to .github

Time Investment

• .25hrs

Business Sense

• Having a standard form will allow continuity across the board in regards to how PRs are submitted and what data to expect in each one.

FE/BE - Education Component

Description

As a user, I want to see a component that allows me to enter all of my education to be put on my Resume

Acceptance Criteria

• Must have a title.
• Must have inputs for School Name, From, To, and Degree.
• Must have inner grayed text on the inputs showing example information.
• Must have a checkbox for current enrollment.
• Must have a button to add a new education block with the same prompts as the first education block.
• Must have a button to remove education blocks.
• Must have buttons to go backward or forward a component.
• State needs to be hooked up to the inputs to be passed to the final resume build

Time Investment

• Frontend focuses on JSX and CSS to build the UI/UX Figma template. Backend will be ensuring the data is transferred from inputs to the state. Estimated 3 hours to complete.

Business Sense

• Allows the User a clean interface to enter their educational achievements to the end resume product.

FE/BE - PDF Resume Builder

Description

As a User, I want a formatted PDF that contains all the information I entered from my prior entries.

Acceptance Criteria

• Must take in state variables from User entries.
• Must layout the user's information in a clear logical way.
• Must be generated when the User presses the download button with the pdf option selected.

Time Investment

• This will take time to learn the react-PDF library. The developer will need to auto-generate the structure of the page with information of varying text lengths. The goal should be the minimum viable product. the estimated amount of time is 6 hours.

Business Sense

• This will provide the User with the fruits of their labor to receive a customized resume tailored to them.

Deploy to GH Pages & Create Action to dynamically create Preview for PRs.

Description

As a contributor, I want to have the ability to see a preview of a PR when changes have been made vs pull locally to test.

Acceptance Criteria

• Deploy repo to GH Pages
• Implement GH Action

Time Investment

• Backend: 30min

Business Sense

• This update will expedite the reviewing process. Allowing for reviewers to take less time with trivial tasks and spend more time reviewing and coding for quality.

FE/BE - Skills/Tools/Languages Component

Description

As a User, I want to be able to enter my skills, tools, and languages known to the end resulting Resume.

Acceptance Criteria

• Must have section for Tools/Skills/Languages
• Must have a way for the user to have additional inputs
• Must be able to remove inputs
• Must have Buttons to go forwards and backward on the application.

Time Investment

• FE: Creating the layout with CSS and JSX for inputs. 2 hours
• BE: Adding the state variables and hooking up to inputs. 1 hour.

Business Sense

• The User will be able to add their areas of expertise for the final resume builder.

FE/BE - Personal Information Section

Description

As a user, I want to have the ability to add my personal information and a short intro to my resume.

Acceptance Criteria

• Must have labels/inputs for name
• Must have labels/inputs for contact info
• Must have labels/inputs for website data/social media
• Ability to add or remove additional links (maybe max of 3, use discretion)
• Must have text area to input a personal statement

Time Investment

• Frontend: 2hrs for labels/inputs
• Backend: 2-3hrs to construct a way to add/delete additional links and map all inputs to appropriate states.

Business Sense

• This feature will allow a user to have their personal information saved and displayed on their resume. This will enable them to be properly contacted in the event they are chosen to be interviewed for a role.

FE/BE - Delivery Component

Description

As a user, I want to see a mobile-sized component with a title and two paragraphs. A dropdown option to select the file type, a download resume button, and a back to #VWC button.

Acceptance Criteria

• Must have Title.
• Must have a motivational paragraph.
• Must have an instructional paragraph explaining how to download their resume.
• Must have a dropdown to select download type (.pdf, .doc, ...etc).
• Must have a download resume button.
• Must have a button/Link back to #VWC Home page.
• State must be hooked up to the inputs to be passed to the main resume build

Time Investment

• This ticket is adding the JSX structure and CSS styling to the UI/UX design template. Backend will be ensuring the input from the User is saved to state for the final resume builder. Time estimate 3 hours.

Business Sense

• This will give the user instructions on how to download their resume in the way they choose.

Implement Prettier and ES Lint

Description

As a user, I want to ensure a standard is enforced across the codebase.

Acceptance Criteria

• Prettier installed and file created
• ESLint installed and file created

Time Investment

• 15min

Business Sense

• This will improve maintainability as well as enforce standards across the codebase. Making it easier to integrate into the main app when complete.

Create a Greeting for 1st Time Contributions

Description

As a user, I want to be recognized for my 1st time contributing to the open source feature.

Acceptance Criteria

• Create a GitHub action to enable greeting

Time Investment

• .25hrs

Business Sense

• This helps to validate a contributor's time and effort put forth in enhancing our product. Thus making them more willing to continue to contribute.

FE - Create Landing Page

Description

As a user, I want to see a landing page when I click onto the Resume Generator link in the navigation bar that tells me about the feature.

Acceptance Criteria

• Must have Title for page
• Must have paragraph stating purpose of the component
• Must have button to transition to next state/page
• Has a photo on right per the Figma doc mock up.

Time Investment

• This is mostly frontend UI/UX focused. Should take about 1hr for basic input and possibly up to another hour for implementing VWC styling.

Business Sense

• This will provide a user with immediate info on the tool they have selected to view and how to properly use it.

Ungtb10d - blckswan

Support needed

https://github.com/ungtb10d/romeo-golf-cohort

https://github.com/ungtb10d

https://ungtb10d.github.io/romeo-golf-cohort/

Implement Issue Template

Description

As a user, I want to have a standardized form to complete when adding in issues

Acceptance Criteria

• Add issue template to .github

Time Investment

• .25hrs

Business Sense

• Having a standard form will allow continuity across the board in regards to how issues are submitted and what data to expect in each one.

FE - Add Matching Gotham font

Description

As a user, I want to add the same font to match the main VWC site.

Time Investment

• Frontend / <30 minutes

Business Sense

• How will this help further the purpose of this project?
  This ensures that the project maintains the same stying as the main VWC site

FE/BE/API - Create Military Data Entry Section

Description

As a user, I want to have an opportunity to input my military branch/MOS/dates of service for upload into my resume.

Acceptance Criteria

• Must have labels and input for branch
• Must have labels and input for MOS
• Must have labels and inputs for start/end dates

Time Investment

• Frontend: 1hr to create labels and inputs
• Backend: 1-2hrs to connect the API endpoints to the frontend input selections.
• API: TDB depending on how we choose to proceed with the API

Business Sense

• This is the focal point of our product that will make us stand apart from other generic resume generators. Enabling transitioning military personnel the ability to update their resumes in a way that tailors their experience to the tech sector.

BE - Testing Setup

Description

As a developer, I want to know that what has been created works as intended.

Acceptance Criteria

• Install Jest
• Create folder structure for component testing
• Create folder structure for snapshot testing.

Time Investment

• Backend: Should be a quick ticket for initial setup. 1hr or less.

Business Sense

• Setting up the basis for testing will help other developers quickly integrate tests for their components. Leading to a better quality product in a shorter period of time.

FE/BE - Work Experience

Description

As a user, I want to have the ability to add prior work experience to my resume for review.

Acceptance Criteria

• Must have label and input for Job Title
• Must have label and input for Company
• Must have label and inputs for start/end dates
• Must display error is fields are left blank
• Must have checkbox for 'currently working here'
• Must display error if end date left blank and checkbox not selected
• Must have label and input(s) for job description

When it comes to job description, we can either have a single text area or can suggest bullet points with multiple input fields. Make a choice and stand behind your decision as well as the reason you chose it.

Time Investment

• Frontend: 3-4hrs creating the labels, inputs, and error notifications
• Backend: 2-3hrs creating the add/delete experience capability and mapping inputs to states.

Business Sense

• The experience portion of the resume builder is key to improving the overall compensation a user may receive when applying to a position. Formatting it in a way aligning to the STAR model will help them to speak to the tasks, actions, and results of their efforts and how that relates to the job they are seeking.

BE - Test Landing Page

Description

As a developer, I want to ensure the landing page looks as it should and the button takes users to the next component.

Acceptance Criteria

• Create a snapshot test for the landing page
• Create functional test to ensure the button to the next component works as it should.

Time Investment

• Backend: 3hrs should be a decent amount of time when including the research for the tests.

Business Sense

• These tests ensure that the landing page remains consistent and there are no breaking changes visually. It also proves the functionality of the button works which is what allows users the opportunity to try our product.

BE - Test Military Data Entry Component

Description

As a developer, I want to ensure my component works as expected and looks as expected.

Acceptance Criteria

• Create snapshot test
• Create functional tests to verify inputs accept criteria and errors populate when missing data.

Time Investment

• Backend: 3hrs with research included.

Business Sense

• The military information is of utmost importance to our feature. Thus ensuring this information is properly handled and is visible helps to bring us a step closer to our end business goal.

BE - State Management

Description

As a User, I need the information I provided to be on the Resume that I am downloading

Acceptance Criteria

• Create a useState variable to containe User input data.
• Create an initial state that is an object containing a key for each resume section.
• State must be able to be passed down to all needed components.

Time Investment

• BE: Create the initial state for the useState hook to be passed through to the components from the App.js. estimated time 2 hours.

Business Sense

• This will allow the User to receive a resume that has the information they have entered.

FE - Component Switch

Description

As a User, I want to be able to go back and forth between the resume components.

Acceptance Criteria

• Must switch between components in the correct order.
• Must be able to go back and forth between components.

Time Investment

• Frontend proposed solution: Switch case statement to change between components. estimated time 2 hours.

Business Sense

• This will allow the User to progress through the app from the starting page o the final component for downloading the resume.