ShoppingList README

Shopping List Fiber Golang Api Example
Explore docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With Golang Fiber Framework
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact
6. Acknowledgments

About The Project

This project will cover essential parts of building backend APIs. From standard coding conventions, how to share data and security concerns that you should always follow to your backend is always secured.

Here's why we used Golang Fiber Framework:

• Built-in strong concurrency and a robust standard library
• High productivity & simplified usage

What you will learn: is how to build a simple CRUD API using Golang Fiber Framework.

Use the README.md to get started.

(back to top)

Built With

These are the necessary tools needed to run this project.

• [![Go][go.dev]][https://go.dev]
• [![Fiber][gofiber.io]][https://gofiber.io]
• [![Gorm][gorm.io]][https://gorm.io]

(back to top)

Getting Started

At this point you should have Golang installed on your machine.

Installation

There are no complex steps to install this project, just follow the steps below.

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/itskenzylimon/ShoppingList.git

3. Run Go Command

    go run main.go

(back to top)

Usage

This is a Crud Api Example using Golang Fiber Framework, it is meant to guide you on how to use the framework to create a simple crud api with a database connection in gorm.

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Your Name - @itskenzylimon - info@kenzylimon.com

Project Link: ShoppingList

(back to top)

Acknowledgments

Resources I found helpful and would like to give credit to.

• Choose an Open Source License
• Fiber Framework
• GORM ORM

(back to top)