https://github.com/iamrosada/go-rest-api
A job opportunities API built using Golang. The API uses Go-Gin as a router, SQLite as a database, and GoORM for database communication. It also includes Swagger for documentation and testing, and a well-organized package structure.
https://github.com/iamrosada/go-rest-api
docker docker-compose go go-gin golang goorm makefile swagger
Last synced: about 2 months ago
JSON representation
A job opportunities API built using Golang. The API uses Go-Gin as a router, SQLite as a database, and GoORM for database communication. It also includes Swagger for documentation and testing, and a well-organized package structure.
- Host: GitHub
- URL: https://github.com/iamrosada/go-rest-api
- Owner: iamrosada
- Created: 2023-10-03T15:47:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-11T14:18:58.000Z (over 2 years ago)
- Last Synced: 2025-01-22T01:36:36.190Z (over 1 year ago)
- Topics: docker, docker-compose, go, go-gin, golang, goorm, makefile, swagger
- Language: Go
- Homepage:
- Size: 33.2 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Job Opportunities API
The Job Opportunities API is a Golang-based application that provides endpoints for managing job opportunities. It uses the Go-Gin framework as a router, SQLite as a database, GoORM for database communication, and Swagger for documentation and testing. The project follows a well-organized package structure for better maintainability and scalability.
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Endpoints](#endpoints)
- [Documentation](#documentation)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## Overview
The Job Opportunities API allows users to manage job opportunities, including creating, updating, deleting, and retrieving job details. It leverages Go-Gin for efficient routing, SQLite for database storage, and GoORM for seamless communication with the database. Swagger is integrated for easy API documentation and testing.
## Features
- Create, update, delete, and retrieve job opportunities.
- Well-organized package structure for clarity and maintainability.
- Integration with Swagger for API documentation and testing.
- SQLite database for data storage.
- GoORM for efficient communication with the database.
## Getting Started
### Prerequisites
To run the Job Opportunities API locally, you need to have the following installed:
- Go (version 1.16 or higher)
- SQLite
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/job-opportunities-api.git