{"id":18621612,"url":"https://github.com/kammradt/tutorial-express-mongodb","last_synced_at":"2025-10-19T23:59:42.878Z","repository":{"id":49675875,"uuid":"235240314","full_name":"kammradt/tutorial-express-mongodb","owner":"kammradt","description":":leaves: A really friendly tutorial on creating an API with Express and MongoDB :leaves:","archived":false,"fork":false,"pushed_at":"2021-06-10T23:41:06.000Z","size":329,"stargazers_count":5,"open_issues_count":6,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-03-12T04:05:54.362Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kammradt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-21T02:31:09.000Z","updated_at":"2021-04-30T03:37:28.000Z","dependencies_parsed_at":"2022-09-16T09:41:48.918Z","dependency_job_id":null,"html_url":"https://github.com/kammradt/tutorial-express-mongodb","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kammradt%2Ftutorial-express-mongodb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kammradt%2Ftutorial-express-mongodb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kammradt%2Ftutorial-express-mongodb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kammradt%2Ftutorial-express-mongodb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kammradt","download_url":"https://codeload.github.com/kammradt/tutorial-express-mongodb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223455086,"owners_count":17147848,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T04:12:55.695Z","updated_at":"2025-10-19T23:59:42.784Z","avatar_url":"https://github.com/kammradt.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# :sparkles: **Welcome to our Express \u0026 MongoDB friendly tutorial!**\n\n|Summary                                                                                    | \n|-                                                                                          | \n| [Who?](#who)                                                                              | \n| [What? *What will we build?*](#what-what-will-we-build)                                   |\n| [Why? *What is our objective?*](#why-what-is-our-objective)                               |\n| [How? *Are are the tools that we will use?*](#how-what-are-the-tools-that-we-will-use)    | \n| [Let's start](#lets-start)\n\n## Result :sparkles:\n### We won!\n\u003e https://github.com/codigofalado/desafio333/pull/46\n\n## Who?\nHi there! My name is Vinícius Kammradt, I`ve been playing with technology since 2016. I really enjoy creating new stuff and also love to spread any knowledge that I have with others.  \nNow, with help from [Gabriela de Almeida Riul](https://www.linkedin.com/in/gabriela-de-almeida-riul-2a1321184/), an Electrical Engineering student and also volunteear at [PET EEL](http://www.peteel.ufsc.br/), who is also interested in development, we will try to beat a challenge proposed by [Código Falado](https://github.com/codigofalado).\n\n## What? *What will we build?*\nThe main idea of this project is to create a complete website to [this challenge](https://github.com/codigofalado/desafio333/blob/master/2020-Janeiro-Leitura-Organica/README.md). \n\u003e O cliente (Leitura Orgânica) precisa de uma Landing Page para possibilitar que o usuário calcule sua velocidade de leitura.  \n\nOur technical structure:\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"./images/structure.png\"\u003e\n\u003c/div\u003e \n\nOur Vue.js website will be bassically a landing page that will use our API to get some information and also be able to manipulate it. We also need the API to be able to send e-mails, so we will use [Sendgrid](https://sendgrid.com/) to do it.\n\n\n## Why? *What is our objective?*\nOur main objective is **learn**. After that, we want to be able to understand how a real website and API work, and after that, create our solution based on what we learned.   \n\n\n## How? *What are the tools that we will use?*\nWe will use **Javascript** as our main programming language.  \nSo, to create our front-end we will use **Vue.js**. Primarily because it is an easy framework to start with and also really powerfull. To make stuff look better we will use **Vuetify**, a library that has styled components.  \nWe will also need some server-side processing to access the Database and send emails, so we will use **Express.js** to do that. This is a really easy to use framework that allows us to create endpoints and also trigger all other stuff that we need to do in the server.  \n\n## Let's start\n\nThe tutorial was divided into some sections. You can verify everything in the table below:\n\n| :speech_balloon: **Introduction**                                     |\n| -                                                                 |\n| [What is a Database?](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/INTRODUCTION.md#what-is-a-database)                        |           \n| [What is an API?](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/INTRODUCTION.md#what-is-an-api)                                |   \n| [HTTP Verbs](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/INTRODUCTION.md#http-verbs)                                         |\n| [Installing MongoDB on Ubuntu](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/INTRODUCTION.md#installing-mongodb-on-ubuntu)     | \n| [Installing a client for Mongo](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/INTRODUCTION.md#installing-a-client-for-mongo)   | \n| | \n| :card_file_box: **Creating the Project and interacting with Database**                      | \n| |                                                                                           |\n| [Creating a project](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#creating-a-project)                                                   |\n| [Learning how to perform CRUD with Mongoose](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#learning-how-to-perform-crud-with-mongoose)   | \n| [What is **CRUD**?](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#what-is-crud)                                                          |\n| [**C**reating the basic file](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#creating-the-basic-file)                                     | \n| [Adding rules to Text model](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#adding-rules-to-text-model)                                   |\n| [**R**eading data](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#reading-data)                                                           | \n| [**U**pdating data](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#updating-data)                                                         |\n| [**D**elete data](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#delete-data)                                                             |\n| |\n| :recycle: **Creating the CRUD**                                       |\n| |\n| [Creating the basic API file](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Creating-the-basic-API-file)           | \n| [Creating routes](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Creating-routes)                                   |\n| [Creating a GET route](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Creating-a-GET-route)                         |\n| [Organizing our files and project](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Organizing-our-files-and-project) |\n| [Creating a real GET route](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Creating-a-real-GET-route)               |\n| [Refactoring the code](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Refactoring-the-code)                         |\n| [Route to CREATE a Text](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Route-to-CREATE-a-Text)                     |\n| [Route to GET one Text](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Route-to-GET-one-Text)                       |\n| [Route to UPDATE a Text](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Route-to-UPDATE-a-Text)                     |\n| [Route to DELETE a Text](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Route-to-DELETE-a-Text)                     |\n| [Route to GET a random Text](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Route-to-GET-a-random-Text)             |\n| | \n| :mailbox_with_mail: **Sending emails using SendGrid**                              |\n| | \n| [Introduction about SendGrid](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_SENDING_EMAILS.md#Introduction-about-SendGrid)                        |\n| [Adding SendGrid library to the project](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_SENDING_EMAILS.md#Adding-SendGrid-library-to-the-project)  |\n| [Creating custom email templates](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_SENDING_EMAILS.md#Creating-custom-email-templates)                |\n| [Sending custom email templates](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_SENDING_EMAILS.md#Sending-custom-email-templates)                  |\n| |\n| :art: **Refactoring and Best practices**                         |\n| |\n| [Splitting routes](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_REFACTORING.md#Splitting-routes)                        |\n| [Using environment variables](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_REFACTORING.md#Using-environment-variables)  |\n| |\n| :lock: **Security**               | \n| |\n| [Introduction about security](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/SECURITY.md/#introduction-about-security)                                 |\n| [Authentication and Authorization](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/SECURITY.md/#authentication-and-authorization)                       |\n| [Securely encrypting data](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/SECURITY.md/#securely-encrypting-data)                                       |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkammradt%2Ftutorial-express-mongodb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkammradt%2Ftutorial-express-mongodb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkammradt%2Ftutorial-express-mongodb/lists"}