Skip to content

Memorize é um site para você criar e revisar os seus Flashcards quando e onde quiser!

License

Notifications You must be signed in to change notification settings

Studio-024/memorize

Repository files navigation

Memorize. O memorize é um site para você criar e revisar os seus Flashcards quando e onde quiser!

   

Tabela de conteúdos


Sobre

Memorize é um projeto sobre um site de Flashcards, o qual foi produzido com o intuito de juntar um time e construir um projeto completo, tanto no login, registro, Interface de Usuário (UI) e Experiência do Usuário (UX) quanto na análise de mercado. Durante o planejamento sua proposta foi que fosse fácil de usar, rápido de revisar, prático e eficiênte, para isso além de toda a interface simples também foi criado um algoritmo de revisão que vai ordenar os cards pela ordem de prioridade de revisão.


Funcionalidades

GIT Badge GIT Badge GIT Badge GIT Badge GIT Badge GIT Badge


Demonstração

Cadastro de usuário


Login de usuário


Revisão dos cards


Criação de cards



Instalação

Nesse capitulo vamos te mostrar como rodar essa aplicação na sua máquina!

Pré-requisitos

✔️ Você precisa ter o NodeJS 14.17.3 ou superior instalado na sua máquina para a aplicação em geral;
✔️ Você precisa ter o Yarn instalado na sua máquina para iniciar a aplicação em geral;
✔️ Você precisa ter o Git instalado na sua máquina para conseguir baixar o repositório;
✔️ Você precisa ter o Xampp instalado em sua máquina para iniciar o Banco de Dados.

Como usar

Após já ter completado os pré-requisitos você deverá abrir o terminal/cmd da sua máquina e digitar:

git clone https://github.com/Studio-024/memorize.git

Você tem todos os arquivos que precisa em sua máquina! Agora entre na pasta do projeto e instale as dependências da raiz do projeto:

yarn install

Vamos ligar o servidor primeiro, entre na pasta server e instale as dependências do server:

yarn install

Inicie o banco de dados:

Linux

yarn db:start

Windows

  1. Abra o XAMPP Control Panel;
  2. De start nos serviços: apache e MySQL.

Antes de inciar a API, precisamos ter o banco de dados criado.

  1. Abra o phpMyAdmin;
  2. Cole o código que está nesta pasta server/scripts/db/all_db_script.sql.

Vamos criar o arquivo .env na raiz da pasta server.

  • Na própria raiz da pasta há um .env.example com todas as informações necessárias para conectar com o banco de dados;
  • Crie o arquivo chamado .env e copie e cole as informações do .env.example substituindo as chaves de acordo com seu banco de dados.
  • Para encontrar as informações necessárias no phpMyAdmin: Seleciona o banco de dados criado e na parte superior da tela selecione o campo "privilégios"

    Em caso de dúvidas com relação a esta etapa, esse post pode ajudar

Agora você tem que abrir um novo terminal ou cmd pra deixar ele rodando a API:

yarn dev

A API e o banco de dados estão ativados! Agora vamos voltar para a pasta raiz do projeto e entrar na pasta Client e instalar as dependências:

yarn install

Vamos ativar o client agora:

yarn start

Espere um pouco até abrir uma nova aba do seu navegador com a URL http://localhost:3000 ou coloque essa URL direto em seu navegador, espere um pouco e o projeto estará funcionando!


Tecnologias

Ferramentas Gerais

Yarn Badge GIT Badge VsCode Badge

Frameworks

React Badge Sass Badge TypeScript Badge
NodeJS Badge ExpressJS Badge MySQL Badge


Contribuidores

Foto de Nicolas Fernando Matsdorf Kisner

Nicolas Fernando Matsdorf Kisner

Instagram Badge


Autores

Foto de Alexandre Costa Belettini

Alexandre Costa Belettini

Linkedin Badge
GitHub Badge

Foto de Pedro Otávio Furtado Duarte

Pedro Otávio Furtado Duarte

Linkedin Badge
GitHub Badge

Foto do GitHub de Vinicius Gregorine Menegon

Vinicius Gregorine Menegon

Linkedin Badge
GitHub Badge

About

Memorize é um site para você criar e revisar os seus Flashcards quando e onde quiser!

Topics

Resources

License

Stars

Watchers

Forks