Skip to content

Alquipo/userCollectionDataUnity-api

Repository files navigation

Unity Logo

User Collection Data Unity API

GitHub language count Repository size Made by Alquipo GitHub last commit License

NodeJS Express JS Swagger Mongo DB Unity

🚀 Sobre o Projeto

🔨 Tecnologias:

🔎 Comandos

  • dev: Inicia um servidor como ambiente de dev localhost:3333
  • build: Cria a Build do projeto
  • start: Inicia um servidor simples com o código de produção

🚀 Como rodar este projeto

Para clonar e executar este aplicativo, você precisará de Git, NodeJs, Yarn Instalado em seu computador.

🌀 Clonando o repositório

# Clone este repositório
$ git clone https://github.com/Alquipo/userCollectionDataUnity-api

# Acesse a pasta do projeto no terminal/cmd
$ cd userCollectionDataUnity-api

🎲 Rodando a Aplicação

# Instale as dependências
$ npm install

# Execute a Aplicação em Desenvolvimento
$ npm run dev

# O servidor iniciará na porta:3333 - acesse http://localhost:3333

💾 Comandos Úteis

#Gerar a build da aplicação
$ npm run build

#Executar a build da aplicação
$ npm run start

📁 Configuração .ENV

#adicionado .env.example no projeto, lembrar de adicionar as variáveis de ambiente conforme o exemplo

# Exemplo de localização do banco de dados
MONGODB_URI=mongodb+srv://<Username>:<Password>@cluster0.sv24h.mongodb.net/<DatabaseName>?retryWrites=true&w=majority

🤔 Como contribuir para o projeto

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

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

Este projeto esta sobe a licença MIT. Veja a LICENÇA para saber mais.

Feito com ❤️ por Alquipo Neto 👋🏽 Entre em contato!

About

This is an API used to store user data and survey, generating a CSV report

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors