Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 3.64 KB

README.md

File metadata and controls

81 lines (54 loc) · 3.64 KB
Raw

Golang-Opportunities API

This project is a modern job opportunities API built using Golang, currently one of the highest paying programming languages. The API is powered by Go-Gin as a router, GoORM for database communication, SQLite as the database, and Swagger for API documentation and testing. The project follows a modern package structure to keep the codebase organized and maintainable.

Features

  • Introduction to Golang and building modern APIs
  • Development environment setup for creating the API
  • Using Go-Gin as a router for route management
  • Implementing SQLite as the database for the API
  • Using GoORM for communication with the database
  • Integrating Swagger for API documentation and testing
  • Creating a modern package structure for organizing the project
  • Implementing a complete job opportunities API with endpoints for searching, creating, editing, and deleting opportunities

Installation

To use this project, you need to follow these steps:

  1. Clone the repository: git clone https://github.com/dyhalmeida/golang-opportunities.git
  2. Install the dependencies: go mod download
  3. Build the application: go build cmd/main.go
  4. Run the application: ./main

Makefile Commands

The project includes a Makefile to help you manage common tasks more easily. Here's a list of the available commands and a brief description of what they do:

  • make run: Run the application without generating API documentation.
  • make run-with-docs: Generate the API documentation using Swag, then run the application.
  • make build: Build the application and create an executable file named golang-opportunities.
  • make test: Run tests for all packages in the project.
  • make docs: Generate the API documentation using Swag.
  • make clean: Remove the golang-opportunities executable and delete the ./docs directory.

To use these commands, simply type make followed by the desired command in your terminal. For example:

make run

Docker and Docker Compose

This project includes a Dockerfile and docker-compose.yml file for easy containerization and deployment. Here are the most common Docker and Docker Compose commands you may want to use:

  • docker build -t your-image-name .: Build a Docker image for the project. Replace your-image-name with a name for your image.
  • docker run -p 8080:8080 -e PORT=8080 your-image-name: Run a container based on the built image. Replace your-image-name with the name you used when building the image. You can change the port number if necessary.

If you want to use Docker Compose, follow these commands:

  • docker compose build: Build the services defined in the docker-compose.yml file.
  • docker compose up: Run the services defined in the docker-compose.yml file.

To stop and remove containers, networks, and volumes defined in the docker-compose.yml file, run:

docker-compose down

For more information on Docker and Docker Compose, refer to the official documentation:

Used Tools

This project uses the following tools:

  • Golang for backend development
  • Go-Gin for route management
  • GoORM for database communication
  • SQLite as the database
  • Swagger for API documentation and testing

Usage

After the API is running, you can use the Swagger UI to interact with the endpoints for searching, creating, editing, and deleting job opportunities. The API can be accessed at http://localhost:$PORT/swagger/index.html.

Default $PORT if not provided=3333.