As I start to go through this project, I got an idea of how I would like to communicate how it’s going through these posts. My goal going forward is to send out updates via these posts once a week as it makes sense. My desire is to send out project updates on Thursdays. That way these updates are consistent and you will always know when to come back and see how progress is going.
Of course, the best way to get updates and know what is going on and when it happens is to subscribe to the Lawn Journal project. That way, you will be sure to know exactly when new content is available, plus all sorts of cool behind the scenes goodies.
On to this weeks work!
This Weeks Update
The Lawn Journal project is still in its infancy, which means I am just getting started with the basics and don’t have a lot of fancy things happening just yet.
This week I have 5 commits to the GitHub Repo to really just get things started. Honestly, it should have only been 2 or 3 commits, but I forgot something and probably could have bundled a couple together. No worries, though. We all make mistakes.
This was really just creating the repository and adding a Python specific .gitignore file, an MIT License, and the initial version of the README.md file. These are things that you can take care of during the repository creation process. I did all of this through the GitHub web interface just to keep things simple.
For this commit, I wanted to start to add additional information about the project to the README file. Adding meaningful content and links to the README file in your repository is very important if you plan on sharing your code with others. This is your main opportunity to give other people some information and background on what your project is about and how to use it.
The name of this commit is fairly self-explanatory. When it comes to working with a new programming language or technology, I highly recommend creating a basic “Hello World” version of the application. It really helps you to get a feel for what the language looks like and what it takes to get it up and running. In this case, I created a simple Hello World version of a RESTful API using Python and Flask.
With my Hello World API completed, it was time to move on to the next step which was to stub out the beginning of the endpoints that will drive most of the application. For this app, those main endpoints have to do with managing Lawns. The main operations we need to support are referred to as CRUD operations:
The initial versions of these endpoints are only printing out to the console that our application received the requests. Pretty simple.
This was really just a simple mistake. When I removed the Hello World endpoint in the previous commit, I forgot to remove the registration of that endpoint from the application. So this was really just to remove a single line.
Like I mentioned earlier, this was a mistake. But it happens to everyone. 🙂
Whenever you are starting a project, be sure to start simple. One of the biggest problems most people have, including myself, is starting off with a grand vision. This is a problem because we start to see this beautify end product in our heads, but once you get started you realize just how much work it will be to get there.
Instead of getting caught up in the grand vision, start will small, simple wins. This way you can see progress.
This is the developer version of putting one foot in front of the other.
So go forth and put one foot in front of the other!