Friendo

Read me in English 🇬🇧 Click here

Aplicação feita utilizando Node, Express, EJS, MariaDB e Sequelize com o propósito de ser uma mini rede social para fazer amigos.

Ajustes e melhorias

O projeto ainda está em desenvolvimento:

• [!] Terminar todos os layouts
• [!] Concluir backend

💻 Pré-requisitos

Para rodar o projeto localmente siga os passos a seguir

• Tenha instalado a versão mais recente do NodeJS e NPM
• Possua o banco de dados MySQL ou MariaDB executando em seu sistema operacional.
• E por final, precisaremos do GIT, poderá fazer o download aqui

🚀 Instalando Friendo

Para instalar o Friendo, siga estas etapas:

Windows e Linux:

1. Execute $ git clone https://github.com/henriquetty/friendo/
2. Entre na pasta criada com $ cd friendo
3. Agora vamos fazer a instalação do projeto $ npm install

🔧 Configurando

O primeiro passo para configurar o projeto em seu ambiente local é criar um banco de dados. Logo após isso renomeie o arquivo .env.example para somente .env e configure o mesmo com os detalhes de seu banco de dados.

1. DB_DIALECT: mariadb ou mysql
2. SERVER_PORT: Porta em que que hospedar o servidor

Execute o comando $ npm run create:table para automatizar a criação da tabela em seu banco de dados que foi previamente configurado.

⚙ Executando

Para botar o projeto no ar é muito fácil, simplesmnente execute $ npm run dev e navegue para localhost:8080 (ou a porta configurada).

📝 Licença

Esse projeto está sob licença. Veja o arquivo LICENÇA para mais detalhes.

⬆ Voltar ao topo