# README

Go-Wiki

Wiki web application models built using Go

Release Tag

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You need Go v1.14+ to install Go-Wiki. Get official installation

Installing

A step by step series of examples that tell you how to get a development env running

Use official go package manager to install Go-Wiki.

go get -u github.com/rjNemo/go-wiki

Usage

In the main application folder launch the server using

go run main.go

Deployment

An example app is deployed on Heroku.

Follow these steps to deploy. Compile the application:

go build -o bin/go-wiki

Make sure that any unused modules have been removed from your application and is resistant to erosion:

go mod tidy
go mod vendor

You will need an .env file such as:

PORT=8080
TMPLDIR=views/templates/
DATABASE_URL=postgres://oshiervtwfrqrr:f177bc7ff355c142931aeb3f3

Built With

Go - Build simple, reliable, and efficient software
Bootstrap - The most popular HTML, CSS, and JS library in the world
PostgreSQL - The world's most advanced open source database

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the CHANGELOG.md and the tags on this repository.

Authors

Ruidy Nemausat - Initial work - rjNemo

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details