Skip to content

FreelasApp/Api

Repository files navigation

GoStack

GitHub language count License Stargazers Stargazers

Sobre   |    Techs   |    Como Usar   |    Como Contribuir   

💈Sobre

O FreelasApp é uma aplicação para auxiliar pessoas ou empresas que estão necessitando de profissionais para desenvolver um determinado projeto ou serviço e, também, ajudar pessoas que trabalham de forma autônoma ou querem fazer um dinheiro extra a encontrar novos projetos ou serviços para desenvolver.💜🚀

Techs

Esse projeto foi desenvolvido utilizando as seguintes tecnologias e ferramentas:

⚡ Executando o Projeto

  • Pré-requisitos

    • É necessário possuir o Node.js v12x instalado na máquina
    • Também, é preciso ter um gerenciador de pacotes seja o NPM ou Yarn.
    • É importante que tenha um banco Sql rodando na sua máquina, de preferência postgreSQL.
  1. Faça um clone:
  $ git clone https://github.com/J-Keven/AppFreelencer.git
  1. Entre na pasta da aplicação:
  $ cd AppFreelencer

Iniciando o backend

  1. Entre na pasta da Api :
  $ cd freelasApp-api
  1. Alterando as informações de conexão com o Banco:
  • Cier um arquivo ormconfig.json na raiz da pasta.
  • Copie o conteúdo do arquivo ormconfig.Example e cole no seu arquivo ormconfig.json.
  • Abra o arquivo ormconfig.json e coloque as informaçõe do seu banco. Ex:
  {
    "type": "postgres",//tipo de banco, postgres, mysql
    "host": "localhost",//onde está sedo executando o banco
    "port": 5432, // A porta que seu banco esta usando
    "username": "postgres", 
    "password": "docker",
    "database": "gobarber",//nome do banco
  }
  1. Instale as depedências:
  # Instale as dependências
  $ yarn
  1. Execute as migrations para criar as tabelas no seu banco:
  # Instale as dependências
  $ yarn typeorm migration:run
  1. Executando a Aplicação:
  # Inicie a API no mode de dev
  $ yarn dev:server

  # Inicie a API no ambiente de produção
  $ yarn start

Iniciando o Mobile

  1. Entre na pasta da aplicação Mobile:
  $ cd freelasApp-mobile
  1. Instalando as dependencias:
  $ yarn
  1. Executando a Aplicação:
  $ yarn start
  1. Executando no Emulador/USB android:
  $ yarn android
  1. Executando no Ios:
  $ yarn ios

🚀 Como contribuir

  • Faça um fork desse repositório;

  • Cria uma branch com a sua feature: git checkout -b minha-feature;

  • Faça commit das suas alterações: git commit -m '[feat]: Minha nova feature';

  • Faça push para a sua branch: git push origin minha-feature.

  • Abra um Pull Request.

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

📝Licença

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


Feito com 💜 by J-keven

About

Api developed for FreelasApp aplication.💜🚀

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published