Save this Job

You can find the deployed project at https://www.savethisjob.com

Save this Job Contributors

Ken Boelter	Kevin Carr	Rose Landroche	Roger Lee
Michelle Scott	Sara Pettigrew	Aaron Spurgeon	Jonathan Taylor

Save this Job Project Overview

Trello Board - https://trello.com/b/cvKexAA0/labspt8-job-book

Product Canvas - https://www.notion.so/Save-this-Job-d479015f772845d8b86099d2a9acb252

UX Design files - https://www.figma.com/file/kgXSUPtM7EBnAMRLt9lcMn/Save-this-Job?node-id=0%3A1

Description of Save this Job project:

Save this Job is a Chrome extension that lets you grab and save job postings with a rating of how interested you are in the job.

Key Features

• Use Chrome extensions from other sites
• Save job searches, all in one place
• Keep job searches organized
• Categorize jobs, applications, interviews, etc.
• Rate jobs by how much interest you have in the job

Tech Stack

Front end built using:

• React
• Redux w/ ReduxToolkit (includes hooks)
• Typescript

Why did you choose this framework?

• To support growth of the app
• Incorporate Semantic UI
• Code readability

Front end deployed to:

https://master.d3d1q8nq7a3fmz.amplifyapp.com/

Back end built using:

https://save-this-job.herokuapp.com/

• Node/Express
• PostgreSQL
• Hosted on AWS

Why did you choose this?

• Node & Postgres was the backend platform database available to use for the project in the labs engineering standards.
• AWS gave us a new challenge to learn in order to host our app.

APIs

https://developer.okta.com/

• Secure register and login
• 2 point authentication at registering
• Easier to maintain

Description of the API

• Secure register and login
• 2 point authentication at registering
• Easier to maintain

Environment Variables

• REACT_APP_CLIENT_ID=...
• REACT_APP_ISSUER=...
• REACT_APP_BASEURL=...
• REACT_APP_GOOGLE_IPD_ID=...
• REACT_APP_LINKEDIN_IPD_ID=...
• REACT_APP_FACEBOOK_IPD_ID=...
• REACT_APP_MAP_TOKEN=...
• REACT_APP_MAP_STYLE=...

Testing

Testing

• TS - Jest This was used because it easily tested our typescript components.

npm install then npm start

Installs all of the dependencies after cloning project. npm ONLY!

Craco start, build and eject

• craco - Create React App Configuration Override. All the benefits of cra and customization without having to use eject by adding a single craco.config.js file to the root of your application.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See [Backend Documentation] https://github.com/Lambda-School-Labs/job-book-be/blob/master/README.mdfor details on the backend of our project.