GitXplorerGitXplorer
D

siga-professor

public
6 stars
0 forks
0 issues

Commits

List of commits on branch main.
Unverified
51e333c17560706095e54a39615a0b06cd2f118d

Exclude govet

DDantasB committed 3 years ago
Unverified
f2d1604b2fdd909786cce60876c964050530a51c

Run golint by source

DDantasB committed 3 years ago
Unverified
fcb86172bf6bc701f9195d14c4433ed0adedc604

Add golang linter

DDantasB committed 3 years ago
Verified
f99df9e4168dd60d7586b27608d33462cba1c95a

Merge pull request #26 from DantasB/controller

DDantasB committed 3 years ago
Verified
d88e1455cb52a927cffe396391a6cea7921fd16a

Merge pull request #25 from DantasB/mongo

DDantasB committed 3 years ago
Verified
073bc4476ac30aa4de55183e33edbd3b564def62

Merge pull request #24 from DantasB/readme

DDantasB committed 3 years ago

README

The README file for this repository.

Siga-Professor

demonstration

Table of Contents

About

This repository is a Simple api that access every UFRJ course and get all the oppened disciplines and their professors. It was built using golang. If you want to see the chart you can access it: MongoDB Chart

Requirements

To run this repository by yourself you will need to have the go compiler on your operational system to run the code bellow.

How to use

API Routes

  • '/filldatabase': This route access every UFRJ course and stores the data in a mongodb.
  • '/professors/<professor_name>': This route only works after the first one.

Program Setup

# Clone this repository
$ git clone <https://github.com/DantasB/Siga-Professor>

# Access the project page on your terminal
$ cd Siga-Professor/

# Create a .env file
$ touch .env  

# Create the following parameters
 CONNECTION_URL="mongodb+srv://{USER}:{PASSWORD}@{HOST}/{DATABASE}?{PARAMS}" #Your MongoDB connection url
 MONGODB_USER #Your MongoDB connection username
 MONGODB_PASSWORD #Your MongoDB connection password
 MONGODB_HOST #The database host
 MONGODB_PARAMS #The params of the connection (retryWrites,w, etc...)
 MONGODB_DATABASE #Your database name

# Compile the entire project
$ go run .

# The code will start in the port 8000

demonstration

Technologies

  • Golang
  • gorilla