Coder Social home page Coder Social logo

g-wiki's Introduction

go-wiki

A KISS wiki built on golang with git as the storage back-end. Content is formatted in markdown syntax. The wiki is rendered with go templates and bootstrap css.

Current running example: wiki.mehl.no

Build and run locally

Ensure that go is installed. Export the GOPATH environment variable to where you checked out the g-wiki project:

export GOPATH=$GOPATH:/some/path/g-wiki/

Download dependencies and compile the binary by:

go get -a
go build -o wiki .

Create a git repository in the files folder:

git init files/

You can now run g-wiki with the standard settings by executing the binary:

./wiki -local=":8080"

Point your web browser to http://localhost:8080/ to see the wiki in action. The wiki tries to store files in a files folder within the project directory. This folder has to exist and be writeable by the user running the g-wiki instance.

Docker

Ensure that docker is installed. The docker file will create a files directory for you, and initialize a git repository there. Rembember that these files are not persistent. Dependent on your environement run docker as root (or not) and execute the following commands:

docker build -t go-wiki:latest .

If this executes succesfully your container is ready:

docker run -d -p 8080:8080 go-wiki:latest

This starts the web application in deamon mode, and the application should be accessible on http://localhost:8080/

g-wiki's People

Contributors

aspic avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

g-wiki's Issues

Search

This is a really nice wiki too for golang.

What do you think about adding search ?
I was thinking of using bleve.
When new files are created, updated and removed i would have to tell the bleve system. The thing could maybe get the hooks off git or the filesystem events.
Curious what your design input is :)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.