Path-18

Web app for informing young people of a variety of careers and paths 🎓

Local Install

Clone the repository.

git clone https://github.com/facn2/path-18.git

Install npm modules.

npm install

Development:

npm run bundle:watch

npm run dev:start

Production:

npm run bundle

npm start

Problem Statement:

• Young people have little exposure to the variety of jobs and careers paths they could pursue.
• Uncertainty around career prospects.
• Little knowledge of the path to take to get a specific job.

User Journey:

As a user I can browse a variety of career paths and view detailed information about the ones that I am interested in.

User Story:

As a user I can...

• Read welcome page and instructions on how to use the app.
• View card with job and decide if I like / dislike it.
• Click on card to view more details.
• View list of jobs I like.
• Click on job to view details on the job and career path.
• Read details instructions for the app in the help page.

---

Prototype:

Take a look at the prototype on figma.

Architecture:

Technologies:

Back-end

• Express

Front-end

• React
• Redux

Database

• Mongo
• Mongoose

Style

• Sass

Team Guidelines:

• CamelCase for JavaScript id's.
• kebab-case for CSS Classes.
• snake_case for multiple word file names.
• Comments where appropriate for code clarification.
• ES6 on backend and ES5 on the frontend.
• All team members should understand code before approval (comments on PR).

Git Flow

• Split each user story into technical tasks.
• Assign yourself to a task and add the in-progress label.
• Small commits with each sub-task of the technical issue.
• Create a [WIP] branch.
• Once the work is complete remove [WIP] and assign each team member to review.
• Remove the in-progress label and add the awaiting-review label and to the issue and PR.
• Request changes if appropriate.
• The final person to approve the PR should assign both QAs to review.
• Close issue after the PR has been merged and all tasks relating to the issue are complete.

Stretch Goals:

• Ability to delete a job from the list of matched jobs.
• Change the app to support Arabic.
• User authentication.
• Use of logic for browsing job options.
• Expand data to include colleges.
• Expand data to include more jobs.