Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gustavo-martins-pereira/agenda_with_express_and_mongodb

A schedule using a basic CRUD, with different screens
https://github.com/gustavo-martins-pereira/agenda_with_express_and_mongodb

bootstrap bootstrap5 course-project css css3 express html html5 javascript nodejs personal-project request-response session udemy

Last synced: about 1 month ago
JSON representation

A schedule using a basic CRUD, with different screens

Awesome Lists containing this project

README

        

# 📒 Projeto Agenda

Projeto feito em **Node** em conjunto com o **Express** para a criação de uma agenda de contatos que podem ser adicionados, excluidos, listados e editados.

![System overview](./gifs/program_resumed.gif)

***

## 🧰 Ferramentas Necessárias
* [Visual Studio Code](https://code.visualstudio.com/) - Editor de código **recomendado** para rodar a aplicação.
* [NodeJS](https://nodejs.org/en/) - Framework JavaScript **necessário** para rodar os comandos de execução do programa.

***

## ⚙ Configurações Iniciais

> IMPORTANTE! O projeto funciona na versão v16.20.0 (LTS) do Node, pode ser que em uma versão diferente o projeto não funcione como esperado, neste caso use o [NVM](https://github.com/coreybutler/nvm-windows) para gerenciar as versões do Node no seu computador

1. Depois de clonado este repositório, abra um terminal na pasta raiz do projeto e digite o comando:

```
npm install
```

Após instalada as bibliotecas necessárias, execute os comandos:

> Observação: Os comandos devem ser executados em terminais diferentes na pasta raiz do projeto

```
npm run start
```

```
npm run dev
```

A sua saída deve ser algo parecido com isso:

![Output do comando npm run start](./images/Configuration-Step_1-run_start.png)

![Output do comando npm run dev](./images/Configuration-Step_1-run_dev.png)

2. Abra algum navegador de sua preferência, (recomendado usar o Chrome), e navegue para a seguinte *URL* *`http://localhost:3000`*.

A seguinte página será exibida:

![Página Index do projeto](./images/Configuration-Step_2-index_page.png)

***

## 🔥 Como Executar

Ao clicar no link de "Register contact" no canto superior direito, um aviso será exibido pedindo para fazer login:

![Aviso pedindo para efetuar login](./images/how_execute-login_required.png)

Para isso, clique no link de "Sign in" para realizar ou a criação de uma conta, ou o login de uma conta já existente.

Depois de logado, um aviso vai aparecer na página dizendo que o login foi efetuado com sucesso:

![Login efetuado com sucesso](./images/how_execute-login_maked.png)

Depois, basta registrar os contatos e ir navegando pelo projeto usando as funcionalidades (gifs abaixo):

### Criando um Contato

![Criação de Contato](./gifs/contact_creation.gif)

### Editando um Contato

![Edição de Contato](./gifs/contact_edition.gif)

### Deletando um Contato

![Deleção de Contato](./gifs/contact_delection.gif)

### Criando uma Conta no Sistema

![Criação de Conta](./gifs/account_creation.gif)

### Logout do Sistema

![Logout do Sistema](./gifs/logout.gif)