Sobre • Funcionalidades • Layout • Como executar • Tecnologias • Como contribuir • Licença

💻 Sobre o projeto

O Memoteca consiste em um mural simulando um pegboard, que permite salvar idéias, memórias, citações, trechos de livros e etc, podendo também marcar seus registros como favoritos.

O projeto foi desenvolvido durante uma aula sobre o framework Angular na Alura

🧰 Funcionalidades

• O usuário deve poder cadastrar uma nova citação contento (opcionalmente) além do conteúdo, o autor e uma estilização (cor);
  • Deve ser possível editar e excluir um registro;
  • Deve ser possível marcar como favorito.
• Deve ser possível listar os registros em formato de mural.
  • Deve haver um campo de busca que permita a busca de um registro por um trecho do texto ou pelo nome do autor.
• Deve ser possível listar apenas os registros marcados como favoritos.

🎨 Layout

O layout da aplicação está disponível no figma:

🚀 Como executar o projeto

Pré-requisitos

Para executar o projeto, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode.

Clonando o repositório

# Clone o repositório
$ git clone git@github.com:eduhaag/Memoteca.git

# Acesse a página do projeto
$ cd Memoteca

Executando o front-end

# Instale as dependências
$ npm install

# Rode o servidor de desenvolvimento
$ npm run start

# O servidor front-end será inicializado na porta padrão do Angular (4200). Acesso http://localhost:4200. 
# Caso a porta já esteja sendo usada, o Angular irá informar a porta para acessar a aplicação.

Executando o back-end

# Acesse a pasta do back-end
$ cd backend

# Instale as dependências
$ npm install

# Rode o servidor
$ npm run start

# O servidor será inicializado na porta 3000 - acesse http://localhost:3000

🛠️ Tecnologias

Front-end

• Angular - e suas ferramentas e bibliotecas internas;
• Typescript.

Veja o arquivo package.json

Back-end

• Json-server

Veja o arquivo package.json

Utilitários

• Protótipo: Figma;
• Editor: Visual Studio Code
• Fontes: Inter, Roboto Mono

💪 Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

📝 Licença

Este projeto está sobe a licença MIT.