sample-go-gin-tailwind

README

Sample Go App

This is a sample Go (golang) app that uses the Gin router, pq, and Gorm to do a basic search
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Built With

• Go
• Tailwind CSS

Go Packages

• Gin
• GORM
• pq

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

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

• Go
• PostgreSQL

# MAC OS X (after installing homebrew)
brew install golang
brew install postgresql

Installation

1. Clone the sample-go-gin-tailwind repo

git clone https://github.com/FrancoRivera/sample-go-gin-tailwind.git && cd sample-go-gin-tailwind

1. Install dependencies

go install

1. Setup database

createuser -P -d -R -S --interactive
# username: houses
# password: chose_a_password
createdb houses -o houses
psql -U houses -f script.sql

Usage

Run the webserver with

PG_USER=db_username PG_PASSWORD=db_password go run main.go

Compile binaries for all architectures with

chmod +x go-executable-build.bash	# make script runnable
./go-executable-build.bash 	  	# run script

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

Franco R - @francodalima - email

Project Link: https://github.com/FrancoRivera/sample-go-gin-tailwind