https://laravel.com/docs/10.x/installation#docker-installation-using-sail
https://laravel.com/docs/10.x/deployment#server-requirements
To run the tests, you need to run the following command on terminal:
./vendor/bin/pest
It took me about 10 hours to complete this challenge.
The API we want you to connect to is https://zenquotes.io/. Read the full documentation.
The application should have the following features:
- All code should be stored in a public GitHub repository.
- You can get a free GitHub account, if you don’t have one.
- There should be separate GIT commits that show progress of development.
- There should be separate GIT commits for framework generated/included code.
- All user information is stored in an SQLite database.
- All quote information is stored in an SQLite database.
- To make testing and review easier, MySQL, MariaDB, PostgreSQL, SQL Server, and/or Redis databases should not be used or be required to run the application.
- Aside from the external API endpoint for quotes, the application should not rely on or use other external or network resources.
- Datastore should be initialized with 3 users.
- Datastore should be initialized with a list containing 3 favorite quotes for each seeded user.
- Datastore initialization should be handled via database migrations and seeders.
- The application should use caching to improve performance.
- Cache data should be stored in an SQLite database.
- Results of an external API calls should be cached for 30 seconds by default.
- The application supports authentication and authorization.
- Users can login with URI “/login” using username and password.
- The username is in the form of a proper email address containing only alphanumeric characters plus at-sign (@), and dot (.).
- Each user is assigned API login token.
- The page is accessible to unauthenticated users.
- The page is accessible to authenticated/logged in users.
- The page allows for currently authenticated users to switch to another authenticated user (with correct credentials).
- The login & logout process does not delete the list of favorites for a previously logged in user.
- The application supports user online registration at URI “/register”.
- The username is in the form of a proper email address containing only alphanumeric characters plus at-sign (@), and dot (.).
- Password must not be stored in clear text format.
- The page is accessible to unauthenticated users only.
- The page redirects to “/today” or login profile for authenticated/logged in users.
- A web page with URI of “/today” that shows “quote of the day”.
- The web page should display cached information, if available, by default
- If cache was used, the quote should be prefixed with an appropriate icon or “[cached]” keyword/tag.
- The same page should also show a “random inspirational image”.
- There should be a button to force a reload of the “quote of the day” with a “new” parameter (e.g., /today/new).
- There should be a button to add the “quote of the day” to the list of favorites.
- Default page when accessing “/” URI.
- The page is accessible to unauthenticated users.
- The page is accessible to authenticated/logged in users.
- A web page with URI of “/quotes” that shows 5 random quotes.
- The web page should display cached information, if available, by default
- If cache was used, the quotes should be prefixed with an appropriate icon or “[cached]” keyword/tag.
- There should be a button to force a reload of list of 5 random quotes with a “new” parameter (e.g., /quotes/new).
- The reload operation updates the cache.
- The page is accessible to unauthenticated users only.
- The page redirects to “/secure-quotes” for authenticated/logged in users.
- A web page with URI of “/secure-quotes” that shows 10 random quotes.
- The web page should display cached information, if available, by default
- If cache was used, the quotes should be prefixed with an appropriate icon or “[cached]” keyword/tag.
- There should be a button to force a reload of list of 10 random quotes with a “new” parameter (e.g., /secure-quotes/new).
- There should be a button to add each quote to the list of favorites for the logged in user.
- The page is accessible to authenticated/logged in users only.
- The page redirects to “/quotes” for unauthenticated users.
- A web page with URI of “/favorite-quotes” that shows all quotes that have been added to the list of favorites.
- There should be a button to delete each quote from the list of favorites.
- The page is accessible to authenticated/logged in users only.
- If the list of favorite quotes is empty, a message should be shown and suggest to the user how to add quotes to the list.
- The page redirects to “/quotes” for unauthenticated users.
- A web page with URI of “/report-favorite-quotes” that shows a list of registered users and favorite quotes they have added to their list.
- There should be a button to delete each quote from the list of favorites for the logged in user only.
- The usernames should be a link that points to the “/login” page with pre-filled username.
- The page is accessible to authenticated/logged in users only.
- The page redirects to “/quotes” for unauthenticated users.
- REST API GET endpoint with URI of “/api/quotes” for Feature: Five Random Quotes.
- The API should return cached information, if available, by default
- If cache was used, each of the quotes should be prefixed with “[cached] ” keyword/tag.
- The API shares cache with the Feature: Five Random Quotes
- The API can be forced to fetch and return fresh set of results (and update the cache) with a “new” parameter (e.g., “/api/quotes/new”)
- The page is accessible to unauthenticated users.
- The page is accessible to authenticated/logged in users.
- REST API GET and POST endpoint with URI of “/api/secure-quotes” for Feature: Ten Secure Quotes.
- The API should return cached information, if available, by default
- If cache was used, each of the quotes should be prefixed with “[cached] ” keyword/tag.
- The API shares cache with the Feature: Ten Secure Quotes
- The API can be forced to fetch and return fresh set of results (and update the cache) with a “new” parameter (e.g., “/api/secure-quotes/new”)
- The API endpoint is secured with API login token.
- The page is accessible to authenticated/logged in users only.
- The page returns empty JSON for unauthenticated users.
- A web page with URI of “/api-test” that allows us to test API endpoints.
- REST API GET endpoints should have clickable links.
- REST API POST endpoints should have a pre-filed form that can be submitted.
- If a user is logged in, REST API GET endpoints should have additional clickable links with API login token.
- If a user is logged in, REST API POST endpoints should have additional pre-filled form with the API login token.
- The page is accessible to unauthenticated users.
- The page is accessible to authenticated/logged in users.
- Create a console/shell command “php artisan Get-FiveRandomQuotes” for Feature: Five Random Quotes.
- The console/shell command should return cached information, if available, by default
- If cache was used, each of the quotes should be prefixed with “[cached] ” keyword/tag.
- The console/shell command shares cache with the Feature: Five Random Quotes
- The console/shell command can be forced to fetch and return fresh set of results (and update the cache) with a “new” parameter (e.g., “php artisan Get-FiveRandomQuotes --new”)
- The console/shell command is accessible to unauthenticated users.
- The console/shell command is accessible to authenticated/logged in users.
- All implemented features are tested.
- Test each implemented feature with at least one Feature test.
- Implement appropriate positive and negative Unit tests for core functionality of the application.
- Provide a README on how we can set up and test the application.
- Please list environment dependencies – e.g., PHP extensions, etc.
- We should be able to run the application on Windows, Mac, or Linux device with your instructions.
- Include a navigation menu that allows to easily click between all features.
- Include a tag [implemented] for implemented features in the README file.
- Include a tag [tested] for tested features in the README file.
- Include a note about the amount of time it took to complete this challenge. We are just being mindful of the amount of time and effort required by the candidate to complete the assignment.
- This is not a race, and lower/higher number alone doesn’t change the outcome/decision.
- What matters is the quality of the code and completing all requirements thoroughly.
- API requests are restricted to 5 per 30 second period.
- API vendor requires that you show attribution with a link back to https://zenquotes.io/ when using the free version of the API.
- HTML/CSS/JS styling are not the primary objective of this coding challenge, but good styling is appreciated.
- It is more important for your application to be feature-full and usable than have a pretty user interface.