This project is a modern API for registering job vacancies 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.
- 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 vacancies API with endpoints for searching, creating, editing, and deleting opening.
- Implementing automated tests to ensure API quality
To use this project, you need to follow these steps:
- Clone the repository:
git clone https://github/aleksanderpalamar/jobs.git - Install the dependencies:
go mod downloads - Build the application:
go build - Run the applications:
./main
The project includes a makefile to help you manage common task more easily. Here's a list of the available commands and a brief description of what they do:
make run: Runs the application without generating API documentation using Swag.make build: Build the application and create an executable file namedjobs-api.make test: Runs tests for all packages on the project.make docs: Generate the API documentation using Swag.make clean: Removes thejobs-apiexecutable and delete the./docsdirectory.
To use these commands, simply type make followed by the desired command. For example:
make runThis project includes a Dockerfile and docker-compose.yml file to help you manage common task more easily. Here's a list of the available commands and a brief description of what they do:
docker build -t jobs-api .: Builds the application and creates an executable file namedjobs-api.docker run -p 8080:8080 -e PORT=8080 jobs-api: Run a container based on the build image. Replacejobs-apiwith the name you used when building the image. You can change the port number is necessary.
If you want to use Docker Compose, follow these commands:
docker compose build: Builds the application and creates an executable file namedjobs-api.docker compose up: Run the services defined indocker-compose.ymlfile.
To stop and remove containers, network, and volumes defined in docker-compose.yml file, use the following commands:
docker compose downThis project is open source and you can contribute to it. You can follow the Contributor Guide to learn how to contribute.
This project is licensed under the MIT License.