Welcome, developer!
This is the repository of the REST API of Chipper, a fictional microblogging application. It has the following features:
- A guest can register
- A user can login with email and password
- A users can not authenticate with an invalid password
- A user can get his session
- A guest can not get his session
- A user can logout
- A guest can not favorite a post
- A user can favorite a post
- A user can remove a post from his favorites
- A user can not remove a non favorited item
- A guest can not create a post
- A user can create a post
- A user can update a post
- A user can not update a post by other user
- A user can destroy one of his posts
As part of our interview process, we'd like to invite you to tackle a technical challenge and share your solution with us. Are you ready? Let's get started!
Please invest some time in acquainting yourself with the codebase, including Models, Controllers, and the database structure.
Duplicate the .env.example file as .env and edit the lines related to the database connection. You'll need to create a local MySQL database, you can call it "chipper". Then you can install dependencies and seed the database by running composer install && php artisan migrate:fresh --seed.
Fork this repository and make sure it's public.
Once you are ready, proceed to address the following tasks one by one.
At present, users have the option to mark posts as favorites.
The goal of this task is to expand this functionality to allow users to also designate their favorite users. Imagine this as a "follow" feature.
We'd like to use the following routes:
POST users/{user}/favorite to add a user to my list of favorites.
DELETE users/{user}/favorite to remove a favorited user from my list of favorites.
To achieve this, we need to deprecate the post_id column in the favorites table. Instead, we'll introduce new columns that support a polymorphic relationship. This relationship will allow the creation of favorites for various models. In this case, User.
It's important to note that the database is already in production. Therefore, you should create new migrations for this task rather than modifying the existing ones.
Please make sure to add testing to the feature, to make sure the user can favorite authors and still can favorite posts. Include all the relevant tests in the tests/Feature/FavoriteTest.php.
Make sure a user can't favorite himself.
✋ BEFORE YOU BEGIN
Please update the following line in this
README.mdfile to include your estimate of the time required for completion.
Estimated Time Required: [Your Estimate Here]
After updating the estimate and right before you start coding, commit your changes using the following command:
git add README.md && git commit -m "Task 1 estimated" && git push
🏁 ONCE YOU HAVE COMPLETED THE TASK
After implementing the changes, commit your work using the following commands:
git add -A && git commit -m "Added the ability for users to favorite authors" && git push
The objective of this task is to modify the endpoint responsible for providing a user's list of favorites. Currently, the endpoint simply offers a list of all favorites, but our requirement is for it to return a JSON structure like this:
{
"data": {
"posts": [
{
"id": 1,
"title": "All about cats",
"body": "Lorem Ipsum...",
"user": { "id": 5, "name": "Jack" }
},
{
"id": 1,
"title": "All about dogs",
"body": "Lorem Ipsum...",
"user": { "id": 1, "name": "Zara" }
}
],
"users": [
{ "id": 5, "name": "Jack" },
{ "id": 8, "name": "Jane" },
{ "id": 9, "name": "Luke" }
]
}
}
As in the previous task, please make sure to add the relevant tests in tests/Feature/FavoriteTest.php.
✋ BEFORE YOU BEGIN
Please update the following line in this
README.mdfile to include your estimate of the time required for completion.
Estimated Time Required: [Your Estimate Here]
After updating the estimate and right before you start coding, commit your changes using the following command:
git add README.md && git commit -m "Task 2 estimated" && git push
🏁 ONCE YOU HAVE COMPLETED THE TASK
After implementing the changes, commit your work using the following commands:
git add -A && git commit -m "Updated structure of favorites index payload" && git push
The users of Chipper want to stay up to date with the people they are following.
Every time a user creates a new post, the system should notify via email to all the users who have them in their list of favorites. The goal of this task is to code that feature.
Please use Laravel notifications. The users should be notified by email only.
For development, feel free to use a service like Mailtrap and the smtp driver to send your email messages to a "dummy" mailbox. For testing, the array driver is fine.
It is of utmost importance that the process of delivering these emails does not lead to delays in the API response for the POST /posts endpoint.
In addition to the implementation, please ensure comprehensive test coverage for this new feature.
✋ BEFORE YOU BEGIN
Please update the following line in this
README.mdfile to include your estimate of the time required for completion.
Estimated Time Required: [Your Estimate Here]
After updating the estimate and right before you start coding, commit your changes using the following command:
git add README.md && git commit -m "Task 3 estimated" && git push
🏁 ONCE YOU HAVE COMPLETED THE TASK
After implementing the feature, commit your work using the following commands:
git add -A && git commit -m "Added notification for users when new post of favorite user is created" && git push
We are looking for a swift method to import users into Chipper. The objective of this task is to develop a Laravel command that can retrieve a list of users from a public JSON file's URL and subsequently create a user for each element up to a given limit.
The command should receive two parameters: URL of the JSON and limit number of users to import.
The JSON file will always follow this structure: https://jsonplaceholder.typicode.com/users. Please use this URL during your development.
Ensure that the corresponsing tests are provided for this feature.
✋ BEFORE YOU BEGIN
Please update the following line in this
README.mdfile to include your estimate of the time required for completion.
Estimated Time Required: [Your Estimate Here]
After updating the estimate and right before you start coding, commit your changes using the following command:
git add README.md && git commit -m "Task 4 estimated" && git push
🏁 ONCE YOU HAVE COMPLETED THE TASK
After implementing the feature, commit your work using the following commands:
git add -A && git commit -m "Added command to import users" && git push
This is an optional task, and we would appreciate your consideration in implementing it. However, there is no pressure to do so.
The objective is to allow users to attach an image while creating a post. To achieve this, you need to enhance the POST /posts endpoint to support optional image attachments. The allowed image file extensions are JPG, PNG, GIF, and WebP.
Once an image is attached, the endpoint should save it appropriately. The URL of the saved image should then be included in the PostResource so it is available on the posts payload.
✋ BEFORE YOU BEGIN
Please update the following line in this
README.mdfile to include your estimate of the time required for completion.
Estimated Time Required: [Your Estimate Here]
After updating the estimate and right before you start coding, commit your changes using the following command:
git add README.md && git commit -m "Extra Task estimated" && git push
🏁 ONCE YOU HAVE COMPLETED THE TASK
After implementing the changes, commit your work using the following commands:
git add -A && git commit -m "Add the ability to post images" && git push
Congratulations! You completed the first part of this interview coding challenge. We'll now leave the API behind and enter the front-end realm.
Please go to the front-end codebase and follow the instructions you'll find on the README. Thank you and good luck!