Skip to content

digi-space/digiutilsapi

Repository files navigation

Digiutilsapi

A simple RESTFUL API that provides many handy tools to make your life much easier.

Go

This simple app is the implementation of my digiutils library, and also one form of #100DaysOfCode movement 🏃‍♂️. There is a docker image 🐋 version as well and if you find it useful please give it a star ⭐ or even do your contribution. Cheers 🥂

Live Demo

You can check the live demo here.

Prerequisites

  • Go 1.19.3 or higher.
  • Swaggo.

Installation

  • Clone this repository.
  • Rename .env.example file to .env and change the PORT value with your desired port.
  • Then run this command to synchronize all the dependencies.
go mod tidy
  • After that run the command below to generate the required files for swaggo.
swag init
  • Finally, run the project.
go run .

Usage

Open your browser and go to http://localhost:3000/swagger/index.html.

NOTE: Replace the 3000 with your defined PORT value in your .env file.

Meta

Hanif Naufal – @Digisata[email protected]

Distributed under the MIT license. See LICENSE for more information.

Contributing

  1. Fork this repository.
  2. Create your own branch (git checkout -b fooBar).
  3. Commit your changes (git commit -am 'Add some fooBar').
  4. Push to the branch (git push origin fooBar).
  5. Create your awesome Pull Request.

About

A simple RESTFUL API using echo framework.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published