Blog

Todo: Mental Model for building 80% of any web/business application for Beginner Programmers — Part 1

 391 total views,  1 views today

Building a mental model and metadata-based approach for beginner programmers

Everything begins with a Todo Application (Twitter, Pinterest, Dribbble, Fiverr, Blog Engine, Reddit, Hackernews, eCommerce, etc).

Everyone is a beginner and everyone has to begin with something at some point in time and never underestimate the power of a Todo application.

This article will not contain any code, but only ideas that you can learn and apply.

This is a live article and more uses cases will be updated over a period of time.

Our object is not only to understand building applications but how to take the learning and build a mental model to apply it to other projects/applications.

Also mastering the below items will help you build almost 80% of applications/projects out there.

  • CRUD
  • Image / File Upload
  • Handling one-to-one relation
  • Handling one-to-many relation
  • Handling many-to-many relation
  • User Authentication and authorization
  • Navigation and Menus
  • Autocomplete
  • Grids and pagination
  • Lazy loading of images and data
  • Cookies, Local Storage and Session Storage (for web projects)
  • Auth provider integration (Google, Facebook, Twitter, etc )
  • Payment Gateway Integration (PayPal, Stripe, etc)
  • DOM Manipulation (for web projects)

Don’t take the Todo app lightly and ignore the naysayers. You won’t believe what you can learn and build with a simple Todo app model.

This post is technology agnostic. Please feel free to use vanilla JavaScript, React, Angular, Vue, Swelte, etc for frontend and Node.js, .NET core, PHP, Ruby, Python, Go, etc for backends.

For database free feel to choose any, PostgreSQL, MariaDB, MySQL, MongoDB, etc.

This model is helpful for building desktop apps as well.

Excuse my wireframes/mockups as I am not a professional designer.

NOTE: The UML Diagram is only for representation. You can adjust the design as needed as long as the core functionality remains the same.

Also, try not to use any third party library or component when creating features. Try creating all components using the UI Library/Framework of your choice from scratch as that will make you better at programming complex features as well.

The White Belt

Level 0 — You are just beginning to code

Let’s begin with a simple model. I will be showing the model attributes and the operations within the same model diagram. For implementation, you can keep the methods/API within the same model or create a separate API layer for the functions that work on the model.

Our first model will look like the below figure.

Your task is to build something that is similar to the screen below.

On deleting a todo a confirmation like below should appear.

Feel free to play with the UI.

The following functionality needs to be implemented.

  • Add todo
  • Edit todo (on click of the edit icon, the corresponding label should change to a textbox and on the press of ENTER key submit the record for saving.
  • Change todo status
  • Delete todo (before deleting a confirmation dialog should be popped up)
  • Select All (and implement the action listed in the dropdown)
  • Filter Todos
  • Color code list according to the status.

The lesson to be learned

  • Setting up a simple CRUD application
  • Understand the fundamentals of application design
  • Interacting with services and database
  • Showing a modal dialog

The Yellow Belt

Level 1— Add Pagination Support

The model being the same and as your product is finding love in the community, the todo list is getting longer. Now to optimize the end user performance implement paging feature as shown below.

There are various ways in which pagination support can be added. For starters refer the below mockup.

The following functionality need to be implemented.

  • Add a basic pagination
  • Ability to select records/rows per page

The lesson to be learned

  • Understand how to code pagination both from the frontend and the backend perspective.
  • Understand the importance of UX and performance.

Level 2— Add Search Feature

Our todos are getting huge and pagination is helping us with great user experience. But getting to a specific item is very difficult. That’s where the search feature comes into play.

The model is the same as above, and let’s take a look at the wireframe.

The following functionality needs to be implemented.

  • On keying in the search term and pressing enter the results should be filtered.
  • The pagination should be re-rendered accordingly to the search result.
  • Implement caching

The lesson to be learned

  • Implement one of the most common functionalities found in any website or application.
  • Importance of caching, challenges and cache invalidation.

Level 3— Adding a favorite icon and animating it

Let’s add a favorite icon (as it’s everyone’s favorite) and animate it on hover. We need to add a field in our model to store the favorites/bookmark items.

Let’s take a look at the updated model. We have added a field called bookmarked which is bool (true /false) and also a method to update the bookmark (or you can also call it as the favorite).

Now, let’s take a look at the wireframe (an only specific extract is shown).

The following functionality needs to be implemented.

  • On click/unclick of heart icon, the item should be added/removed from the favorite list.
  • On click of the bookmark icon at the bottom of the screen, only the Favorited items should be listed.
  • Animate when hovering over the heart icon ❤️

The lesson to be learned

  • How CSS transition/ animation works

The completed UI so far should look like the below figure.

Congratulations and now you have built an app that works great for a single user. In the next levels, we will highlight the features to make our Todo app work for multiple users.

The Orange Belt

Level 4— Adding the register and login feature

Let’s take a look at the model diagram.

So now, every Todo item is associated with a user model, i.e. there is a one to many associations between User and Todo.

Let’s create a user registration screen.

The following functionality needs to be implemented.

  • On click on “REGISTER”, the user details should be stored in the database.
  • The password should be hashed and stored in the database.
  • If the user already exists with the same email/username, then an error message should be displayed to the client.
  • If the user is successfully created, the client should be redirected to the login page.

And the login screen

The following functionality needs to be implemented.

  • On click of “LOG IN”, the email/password should be validated.
  • If the user is successfully validated, then a token should be sent from the server to the client.
  • This token will be used to authorize the user for subsequent requests.
  • The client should be redirected to the home page (where his list of todos are displayed)
  • The user profile name should be displayed on the screen.
  • A dropdown menu should be displayed with “logout” and “profile” option.
  • When saving or editing todo the current userId should be saved along with the todo item.

The new home page once the user successfully login should be as per the wireframe.

The lesson to be learned

  • Local authentication
  • Implementing routes and navigation
  • Understanding session management
  • Hashing
  • Redirection to page
  • Token-based authentication

Level 5— Logout feature

Refer to the above wireframe. When clicked on the logout option, the users session data should be cleared, (any cleanup that is required, needs to be done) and the user should be redirected to the login page.

By implementing the above features, now every signed in user gets to manage his/her todo list.

The Green Belt

Let’s implement one-to-many associations. Now, it may happen that our one todo item can be subdivided into multiple steps. So, let’s model one-to-many associations between a todo item and it’s subtasks.

Level 6— One to one association

Let’s add a category to every todo. The model looks like the figure below.

NOTE: The Todo model has a reference to the Category Model.

The wireframe can be implemented as shown below. I have slightly changed the UI to accommodate the new field.

The following functionality needs to be implemented.

  • The category field should be populated from the category table in the database (make an ajax call). The display_name should be populated in the dropdown list.
  • On saving the todo, the category_id should be saved along with the todo model.

Level 6.1— Building the Category Form (CRUD)

Here is a quick wireframe.

The following functionality needs to be implemented.

  • Implement CRUD feature for category master

Level 7— One to many associations

The updated model is shown below. We now have a new SubTask model that has a reference to the Todo model.

Now, let’s take a look at the updated wireframe and how you would go about implementing this feature.

The following functionality needs to be implemented.

  • Add an add icon to every todo item.
  • On click of the add icon a new panel/dialog/box to be open that contains input fields for adding subtasks.
  • All features remain same within subtasks (except we don’t have a favorite option here, but you can add it if you want)
  • On saving the subtasks, the corresponding todoId should be saved as part of the subtask item.
  • BONUS: When all the subtasks are marked as completed, you can automatically mark the main todo as completed as well. (This can be part of an application setting, for e.g. Automatic mark main task as complete when all subtasks are completed”.

NOTE: This article was originally published on medium https://codeburst.io/todo-mental-model-for-building-80-of-any-web-business-application-for-beginner-programmers-a3e1a57e5a75

That’s it for part 1. Watch out for part 2 where we will add more features to the app and then in subsequent parts will create the meta-model to simulate common applications like e-commerce, blog, twitter, Pinterest, Hackernews, Reddit, etc.

How useful was this post?

Click on a heart to rate it!

Average rating 5 / 5. Vote count: 5

No votes so far! Be the first to rate this post.

Leave a Reply

Your email address will not be published. Required fields are marked *