diff --git a/README.md b/README.md index ee2643c..a05ac91 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ +
+ + ![App logo](./public/img/ImageBox_logo.svg) -# PictoSplash -An image search engine platform created in React. Uses the Unsplash API to search for pictures. +
+ +# ImageBox + +An image search engine web app created in React. Uses the Unsplash API to search for pictures and React for its Front End framework. ## App Screenshot @@ -12,7 +18,6 @@ An image search engine platform created in React. Uses the Unsplash API to searc - [Resources used](#resources-used) - [Testing tools used for the app](#testing-tools-used-for-the-app) - [Running automated tests](#running-automated-tests) -- [Project resources](#project-resources) - [Completed tasks](#completed-tasks) - [Future app tasks](#future-app-tasks) @@ -45,7 +50,7 @@ An image search engine platform created in React. Uses the Unsplash API to searc - ```npm run litereport``` to run local Lighthouse tests - ```npm run fullaudits``` to update local components and review if any packages are outdated -### Completed app tasks: +### Completed tasks: - [x] Update UI design for app - [x] Complete Unsplash picture API intergration @@ -53,7 +58,7 @@ An image search engine platform created in React. Uses the Unsplash API to searc ### Future app tasks: -- [ ] Add a preloader svg to the search engine app -- [ ] Make all UI elements inside the app act responsively to any device (Desktop, smart phones, tablets) -- [ ] Add a 404 error / search results not found page -- [ ] Increase current app's API request limit per hour from 50 hits to 5,000 hits \ No newline at end of file +- [ ] Make the app fully responsive on all platforms and devices. App currently supports only desktop view +- [ ] Add a spinning circle preloader svg to the search engine app while searching for images +- [ ] Add a 404 error page and a "image not found" search query results page or display element +- [ ] Increase current app's API request limit per hour from 50 hits to 5,000 hits per hour \ No newline at end of file diff --git a/docs/BUG_REPORT.md b/docs/BUG_REPORT.md index 552f42b..6083a44 100644 --- a/docs/BUG_REPORT.md +++ b/docs/BUG_REPORT.md @@ -2,32 +2,40 @@ -**Describe the bug** +## Describe the bug + -**To Reproduce** +## To Reproduce + + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +### Expected behavior + -**Screenshots** +### Screenshots + -**Desktop (please complete the following information):** - - OS: [] - - Browser [] - - Version [] +### Desktop (please complete the following information): + +- OS: [] +- Browser [] +- Version [] + +### Smartphone (please complete the following information): + +- Device: [] +- OS: [] +- Browser [] +- Version [] -**Smartphone (please complete the following information):** - - Device: [] - - OS: [] - - Browser [] - - Version [] +### Additional context -**Additional context** diff --git a/docs/FEATURE_REQUEST.md b/docs/FEATURE_REQUEST.md index c8cec8a..be46523 100644 --- a/docs/FEATURE_REQUEST.md +++ b/docs/FEATURE_REQUEST.md @@ -2,14 +2,17 @@ Suggest an idea for this project -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. *"When running this feature, the app behaves oddly [...]"* +## Is your feature request related to a problem? Please describe. +A clear and concise description of what the problem is. + -**Describe the solution you'd like** +## Describe the solution you'd like A clear and concise description of what you want to happen. -**Describe alternatives you've considered** +## Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered. -**Additional context** +### Additional context Add any other context or screenshots about the feature request here. diff --git a/docs/ISSUES_TEMPLATES.md b/docs/ISSUES_TEMPLATES.md deleted file mode 100644 index 6468d2f..0000000 --- a/docs/ISSUES_TEMPLATES.md +++ /dev/null @@ -1,42 +0,0 @@ -# List of changes made: - -- -- -- - - ----------------------------------------------------------------- -# Type of Issue: - -* New feature request -* Bug report-Major -* Bug report-Medium -* Bug report-Small - ----------------------------------------------------------------- -# Recent issue description - - - ----------------------------------------------------------------- -# Possible solution: - - - ----------------------------------------------------------------- -# Step by step guide for recent PR: - -1. -2. -3. - ----------------------------------------------------------------- -# Context of current issue: - - - ----------------------------------------------------------------- -# Your current work environment: - - ----------------------------------------------------------------- \ No newline at end of file diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md index c28cf4d..43d5acc 100644 --- a/docs/PULL_REQUEST_TEMPLATE.md +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -4,23 +4,23 @@ - - ----------------------------------------------------------------- + # Type of PR -* New feature -* Code cleaning -* New documentation -* Bug fix (Major, Medium, Minor) +- New feature +- Code cleaning +- New documentation +- Bug fix (Major, Medium, Minor) +- Tests (Manual and automatic) ----------------------------------------------------------------- ## PR description - [] Recent PR does not interfere with app functionality - [] Recent PR does not fail any tests ----------------------------------------------------------------- +