Skip to content

NecmettinCimen/blog-api-golang

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn SonarQube Cloud


blog-api-golang

Blog API with JWT authentication, PostgreSQL database, and Swagger documentation
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Publish & Release on Docker
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

blog-api-golang Screen Shot

Blog API with JWT authentication, PostgreSQL database, and Swagger documentation

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

Technologies: go gin postgresql gorm jwt swagger docker

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • go
    download & install https://go.dev/doc/install

Installation

  1. Clone the repo
    git clone https://github.com/necmettincimen/blog-api-golang.git
    Goto Api Directory
    cd blog-api-golang 
  2. Run Project
    go run main.go
  3. Goto
    https://localhost:8080/swagger/index.html

Publish & Release on Docker

  1. Clone the repo
    git clone https://github.com/necmettincimen/blog-api-golang.git
    Goto Api Directory
    cd blog-api-golang 
  2. Build Image
    docker compose build .
  3. Docker Compose Up
    docker compose up

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

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

Contact

Your Name - @Necmettin Cimen - [email protected]

Project Link: https://github.com/necmettincimen/blog-api-golang

Acknowledgements

About

📚 Blog API with JWT authentication, PostgreSQL database, and Swagger documentation

Topics

Resources

Stars

Watchers

Forks