For this project, your goal is to expand upon the Rails project you did previously. The goal is to add dynamic features that are possible through jQuery, a JSON API and an Object Oriented JS convention for your application. Do not use remote: true in this application. Your AJAX requests should retrieve JSON and not an html.erb template.
At its core, this project consists of (at least) 3 separate AJAX requests, with each JSON response sent to custom Javascript objects to be rendered to the DOM.
-
Must render at least one list of resources via jQuery and JSON Backend. For example, in a blog domain with users and posts, you might display the list of the user posts on the users show page. It would fetch the posts via an AJAX GET request, the backend would return the posts via JSON, then Object Oriented JS would format the response and append the posts to the page.
-
Must render at least one single resource via jQuery and JSON Backend. For example, in the blog domain, you might allow a user to sift through the posts by clicking a 'Next' button on the posts show page, with the next post being fetched and rendered via JQuery/AJAX.
-
Must intercept a form to create a resource and render the response without a page refresh. For example, a user might be able to add a comment to a post, and submit it via an AJAX POST request, with the response being the new object in JSON. The new record would then be formatted with OO JS and appended to the DOM.
-
Must translate the JSON responses into Javascript Model Objects. The Model Objects must have at least one method on the prototype. Formatters work really well for this. Borrowing from the previous example, instead of plainly taking the JSON response of the newly created comment and appending it to the DOM, you would create a Comment prototype object and add a function to that prototype to perhaps concatenate (format) the comments authors first and last name. You would then use the object to append the comment information to the DOM.
-
Your application should conform to Nitro's Ruby linting conventions. This should already be included in your original rails project repo. Running rubocop from your application's root should return a no offenses detected message.
-
Your application should contain at least 4 Model test files (you should have 2 already), at least two request specs, and at least 1 system test. But the more, the better :). Each file should attempt to provide coverage over a number of public methods or endpoints in your application. Review the
Testingsection of the curriculum for some tips on best test practices.FactoryBotwill be need to be added to your project to use test factories if it is not already.Capybaraandpoltergiestmay also need to be added to your project to support your system tests. Utilize your instructor, peers, and other Nitro Developers for resources and ideas on what your application should test.
- Make the changes to your existing Rails assessment repo.
- Add the requirements.md file from this repo to the root directory of the project, commit it to Git and push it up to GitHub.
- Build your app. Make sure to commit early and commit often. Commit messages should be meaningful (clearly describe what you're doing in the commit) and accurate (there should be nothing in the commit that doesn't match the description in the commit message). Good rule of thumb is to commit every 3-7 mins of actual coding time. Most of your commits should have under 15 lines of code and a 2 line commit is perfectly acceptable. This is important and you'll be graded on this.
- Make sure to check each box in your requirements.md and explain next to each one how you've met the requirement before you submit your project.
- Give minimal description of application, then have the reveiwer walk through it. 2-5 minutes.
- Run down each item in your
requirements.mdand explain how you've met each criteria. 5-10 minutes - Refactor code or extend the application with a new feature, more data, etc. 50-55 minutes