Skip to content
This repository has been archived by the owner on Feb 15, 2022. It is now read-only.
/ Todoey Public archive

A application to save, edit and delete a to-do reminder, made in Angular with TypeORM and Typescript on Rest API

License

Notifications You must be signed in to change notification settings

lucasliet/Todoey

Repository files navigation

GitHub deployments GitHub deployments GitHub GitHub repo size GitHub top language


📰️ Índice

📚️ Sobre

Todoey é um app de cadastro de lembretes feito em Angular como projeto da Universidade São Judas Tadeu da turma de ADS 4º Semestre

o backend utilizado pode ser encontrado na branch rest

👨‍💻️ Tecnologias Utilizadas

Alguns destaques nas tecnologias utilizadas neste projeto são:

🔎️ Preview

O mockup utilizado para o projeto está disponivel no Figma

📝️ Como utilizar

Você pode acessar a versão web pelo link http://ads-usjt.github.io/Todoey tanto pelo computador quanto pelo celular, ele também é instalavel como PWA, adicionando um atalho no celular para abrir como um app

QR-Code

⚙️ Para baixar e reproduzir o projeto

  • Pré-requisitos

    • É necessário ter instalado o git, caso esteja no Windows, baixe o instalador,no Ubuntu e derivados pode ser instalado com
    # apt install git -y
    
    • É necessário possuir o Node.js instalado
    • Também, é preciso ter um gerenciador de pacotes seja o NPM ou Yarn.
    • Por fim, é essencial ter o Angular CLI instalado de forma global no seu ambiente
    # npm i g @angular/cli 
    
  1. Faça um clone:
  $ git clone https://github.com/ads-usjt/Todoey.git Todoey/angular
  $ git clone https://github.com/ads-usjt/Todoey.git Todoey/backend
  $ cd Todoey/backend
  1. Executando o backend:
  # Mude para a branch da API REST
  $ git checkout rest

  # Instale as dependências
  $ yarn install

  # Inicialize o banco de dados temporário
  $ yarn typeorm migration:run

  # Inicie a aplicação rest
  $ yarn dev
  1. Executando a aplicação web
  # Em outro terminal navegue até a pasta angular no projeto
  $ cd ../angular

  # Instale as dependências
  $ yarn install

  # Inicie a aplicação web
  $ ng serve -o

🤝️ Como contribuir

  • Faça um Fork desse repositório,
  • Crie uma branch com a sua feature: git checkout -b my-feature
  • Faça um commit com suas mudanças: git commit -m 'feat: My new feature'
  • Faça um push da sua branch: git push origin my-feature
  • Abra um Pull Request no github explicando suas mudanças e o motivo para elas

👮 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.


Feito com ❤️ por Lucas Souza | Leonardo Gil | Jonathan Araújo

About

A application to save, edit and delete a to-do reminder, made in Angular with TypeORM and Typescript on Rest API

Topics

Resources

License

Stars

Watchers

Forks