Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kammradt/tutorial-express-mongodb

:leaves: A really friendly tutorial on creating an API with Express and MongoDB :leaves:
https://github.com/kammradt/tutorial-express-mongodb

Last synced: about 2 months ago
JSON representation

:leaves: A really friendly tutorial on creating an API with Express and MongoDB :leaves:

Awesome Lists containing this project

README 

        
# :sparkles: **Welcome to our Express & MongoDB friendly tutorial!**



|Summary                                                                                    | 

|-                                                                                          | 

| [Who?](#who)                                                                              | 

| [What? *What will we build?*](#what-what-will-we-build)                                   |

| [Why? *What is our objective?*](#why-what-is-our-objective)                               |

| [How? *Are are the tools that we will use?*](#how-what-are-the-tools-that-we-will-use)    | 

| [Let's start](#lets-start)



## Result :sparkles:

### We won!

> https://github.com/codigofalado/desafio333/pull/46



## Who?

Hi 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.  

Now, 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).



## What? *What will we build?*

The 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). 

> O cliente (Leitura Orgânica) precisa de uma Landing Page para possibilitar que o usuário calcule sua velocidade de leitura.  



Our technical structure:



    

 



Our 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.



## Why? *What is our objective?*

Our 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.   



## How? *What are the tools that we will use?*

We will use **Javascript** as our main programming language.  

So, 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.  

We 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.  



## Let's start



The tutorial was divided into some sections. You can verify everything in the table below:



| :speech_balloon: **Introduction**                                     |

| -                                                                 |

| [What is a Database?](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/INTRODUCTION.md#what-is-a-database)                        |           

| [What is an API?](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/INTRODUCTION.md#what-is-an-api)                                |   

| [HTTP Verbs](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/INTRODUCTION.md#http-verbs)                                         |

| [Installing MongoDB on Ubuntu](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/INTRODUCTION.md#installing-mongodb-on-ubuntu)     | 

| [Installing a client for Mongo](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/INTRODUCTION.md#installing-a-client-for-mongo)   | 

| | 

| :card_file_box: **Creating the Project and interacting with Database**                      | 

| |                                                                                           |

| [Creating a project](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#creating-a-project)                                                   |

| [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)   | 

| [What is **CRUD**?](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#what-is-crud)                                                          |

| [**C**reating the basic file](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#creating-the-basic-file)                                     | 

| [Adding rules to Text model](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#adding-rules-to-text-model)                                   |

| [**R**eading data](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#reading-data)                                                           | 

| [**U**pdating data](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#updating-data)                                                         |

| [**D**elete data](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/PROJECT_DATABASE.md#delete-data)                                                             |

| |

| :recycle: **Creating the CRUD**                                       |

| |

| [Creating the basic API file](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Creating-the-basic-API-file)           | 

| [Creating routes](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Creating-routes)                                   |

| [Creating a GET route](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Creating-a-GET-route)                         |

| [Organizing our files and project](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Organizing-our-files-and-project) |

| [Creating a real GET route](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Creating-a-real-GET-route)               |

| [Refactoring the code](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Refactoring-the-code)                         |

| [Route to CREATE a Text](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Route-to-CREATE-a-Text)                     |

| [Route to GET one Text](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Route-to-GET-one-Text)                       |

| [Route to UPDATE a Text](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Route-to-UPDATE-a-Text)                     |

| [Route to DELETE a Text](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_CRUD.md#Route-to-DELETE-a-Text)                     |

| [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)             |

| | 

| :mailbox_with_mail: **Sending emails using SendGrid**                              |

| | 

| [Introduction about SendGrid](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_SENDING_EMAILS.md#Introduction-about-SendGrid)                        |

| [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)  |

| [Creating custom email templates](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_SENDING_EMAILS.md#Creating-custom-email-templates)                |

| [Sending custom email templates](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_SENDING_EMAILS.md#Sending-custom-email-templates)                  |

| |

| :art: **Refactoring and Best practices**                         |

| |

| [Splitting routes](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_REFACTORING.md#Splitting-routes)                        |

| [Using environment variables](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/API_REFACTORING.md#Using-environment-variables)  |

| |

| :lock: **Security**               | 

| |

| [Introduction about security](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/SECURITY.md/#introduction-about-security)                                 |

| [Authentication and Authorization](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/SECURITY.md/#authentication-and-authorization)                       |

| [Securely encrypting data](https://github.com/kammradt-archives/tutorial-express-mongodb/blob/master/NOTES/SECURITY.md/#securely-encrypting-data)                                       |