You can find the deployed project at Ping Catcher.
| Trevor Martin | Jamelle Boose | Eric Santos | Kyle Pace | Mason Roberts | Matt Steele | Aaron Anderson |
|---|---|---|---|---|---|---|
 |
 |
 |
 |
 |
 |
 |
| |
|
 |
|
|
|
|
####Code Climate Project under review and scored by Code Climate
Tech used in this project
Ping catcher is a software solution that allows one to prioritize, color code, organize, and filter incoming notifications.
There are too many distractions from mentions/pings through the day. Work flow and deep work is highly disrupted because of it. Currently, there is no method of organizing important/high priority communication from the rest.
- Security with Okta
- Organize pings by categories
- Organize pings by color
- Snooze ping to review later
- Customize dashboard
React, Okta, React-testing, Material-Ui
- React create elements in a virtual DOM.
- React creates and maintains state.
- React will only change elements needing to be changed.
- React does not need to refresh the entire page.
Front end deployed to https://aws.amazon.com
Back end built using:
- Express is an easy and common framework for creating server end points.
- Middleware is easy to create and implement
- PostgresSQL make it easy to protect data
Authentication for the App is handled by Okta. We utilize Okta's Oauth system and backend. We pass the user information to Okta. Okta verifies the credentials and sends back a token we use to give access to the user. If the user is not registered, we have set up Okta to allow them to register into the Okta system.
In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:
Production Okta server
- REACT_APP_OKTA_CLIENT_ID=
- REACT_APP_OKTA_ORG_URL=
- SPA_CLIENT_ID=
Create your account at Okat. Follow the docs to create your Okta server. Paste in your client id's and the server url.
Development Okta server
- REACT_APP_OKTA_IMPLICIT_CALLBACK_URL=http://localhost:300/implicit/callback
- REACT_APP_OKTA_API_MESSAGES=http://localhost:300/api/messages
- PORT=300
Once your Okta server is up, you can add local development for working and testing. This allows you to run production and development from the same server. Review Okta docs.
Images, icons, etc, that are used in this project. The list below is to the lic. for original content. Some images, icons, etc many have been changed, adjusted or reworked for this project.
| Image Filename | Source / Creator | License |
|---|---|---|
| 2 white ballons.png | Photo by Miguel Á. Padriñán from Pexels | Creative Commons |
| icons.svg | Font Awesome | Creative Commons |
We used the @testing-library/react and @testing-library/jest-dom for the testing of this App. To run a single test, run yarn test from the terminal. To watch your tests and run on save, run yarn test:watch
The Frontend utilizes Yarn while the Backend utilizes NPM. To get started with the Frontend, clone the Frontend into it's own folder on your system. Run yarn install in the terminal to install all the packages from the package.json. In the 'root' directory, create your '.env' file and then copy and paste the environment variables from above into it. Save and run yarn start.
* build - creates a build of the application
* start - starts the production server after a build is created
* test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them
* test:watch - watch's the **tests** directory for changes and runs test's on save
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.
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.
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.
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.
- 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.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Backend Documentation for details on the backend of our project.