API + [NodeJS] Blocks Assistant Project Basics: Learn To Build Backend API

[samuko-things]

Prerequisite

Ensure that you have completed the Git & GitHub Workflow "Good First Issue" Tickets. If you have not done or completed the Git and GitHub tickets, you can find it through the project board here: git and github workflow good first issue tickets

Background

There is an aspect of the Blocks Assistant project, that involves developing backend API boilerplate templates that the CLI generates. The understanding of how a NodeJS backend API is built and how it works, is crucial to quickly becoming acquainted with how the Blocks Assistant backend API boilerplate is built and how it works. You will also learn the basics of how to document a project.

Issue description

Create a NodeJS backend API, code along with the instructor in this youtube tutorial: https://www.youtube.com/watch?v=BWUi6BS9T5Y.

Expected solution

• Compulsory: Your API should look like and be able to do what that of the instructor's own can do.
• Compulsory: Document useful information about your API that will help users/contributors to understand the project you built. Let the readme of the buuks-express-api API guide you when writing your own API's readme.
• Optional: You can choose to add a new functionality to your API, or fix a bug you noticed wasn't fixed in the tutorial (if you notice any).

Additional context

• Let us know in the comment of this issue ticket (GitHub discussion) that you will be participating in this project basics assignment. Ensure to tag @collabo-community/maintainers in your comment. That way, maintainers will be notified and will be prepared to help review your pull request when you submit.
• Where to do this project? - Create and do this library project in a GitHub repository in your personal GitHub account. Make sure it is a public repository so that other people can see it.
• Submission details:
  • Repo URL (where you are to do and submit this task to): https://github.com/collabo-community/good-first-issue-solutions
  • More details about how to submit to the above Repo URL:
    • If you don't have this file, create a file called project-basics.md in root of the folder that has your GitHub username in it.
    • Ensure that there's an H1 header in the file:

       # Project Basics by @replace-this-text-with-your-own-GitHub-username
      

    • Under the header section, add this list item and insert your API's GitHub repository link in this manner:

       - API + [NodeJS] Blocks Assistant Project Basics: Replace this part of the text with your API's GitHub repository link
      

• If you have any questions or need any clarification when working on this ticket, please use the #good-first-issue-support channel in our discord community server.
• To help you understand how to work with other contributors within the @collabo-community better, we will review your pull request based on the directions given in this issue ticket and our Public Documentation Resource Guide.

Testing checklist

Note (to contributor taking on this task assignment): Copy and paste the testing checklist below (without this note) to your pull request body description when submitting your fix. This will guide (you and) the contributors who will review your fix to know what is important to check or test for.

• Here's the link to my approved pull request for the Git & GitHub Workflow 6th task: Replace this inline code block with the link to your approved Git & GitHub Workflow 6th task pull request
• My API is in a GitHub repository in my personal GitHub account.
• My API looks like and is able to do what that of the instructor's own can do.
• I have documented useful information about my API in my API's repository readme. The readme adopts ideas from the buuks-express-api API.
• I have a project-basics.md file in root of the folder that has my GitHub username in it.
• I have a formatted (H1) header text in the .md file:
  # Project Basics by @replace-this-text-with-your-own-GitHub-username
• Under the header section, I have added this list item, and I have inserted my API's GitHub repository link:
  - API + [NodeJS] Blocks Assistant Project Basics: Replace this part of the text with your API's GitHub repository link
• I certify that I ran my checklist.