Categorygithub.com/ADS-Unifg/ClassApi
modulepackage
0.0.0-20241114220026-5bd58f2833ac
Repository: https://github.com/ads-unifg/classapi.git
Documentation: pkg.go.dev

# README

API em Go (ClassAPI) - Go 1.23.0

Este projeto é uma API simples para cadastro dos alunos da univercidade unifg desenvolvida com GoLang que utiliza MongoDB como banco de dados. As instruções a seguir orientam sobre como configurar e rodar o projeto.

Pré-requisitos

  • Go: Certifique-se de que o Go 1.23.0 ou superior está instalado na sua máquina. Se não tiver, faça o download aqui.
  • MongoDB: Ter uma instância do MongoDB rodando. Você pode usar o MongoDB Atlas ou uma instância local do MongoDB.

Configuração do Projeto

  1. Clone este repositório:

    git clone https://github.com/ADS-Unifg/ClassApi
    cd ClassApi
    
  2. Remova o sufixo -example do arquivo .env-example:

    mv .env-example .env
    
  3. Edite o arquivo .env para adicionar a URL de conexão com o MongoDB. O conteúdo do arquivo deve se parecer com:

    MONGO_URI=mongodb+srv://<usuario>:<senha>@<cluster-url>/<nome-do-banco>?retryWrites=true&w=majority
    
  4. Execute o comando para resolver as dependências do projeto:

    go mod tidy
    

Rodando a Aplicação

  1. Para iniciar a aplicação, execute o comando:

    go run main.go
    
  2. A aplicação será iniciada e estará disponível no endereço http://localhost:8080.

Contato

Se precisar de ajuda, entre em contato

# Structs

No description provided by the author