mirror of
https://github.com/rjNemo/go-wiki
synced 2026-06-06 02:36:40 +00:00
65 lines
2 KiB
Markdown
65 lines
2 KiB
Markdown
# Go-Wiki
|
|
|
|
Wiki web application models built using `Go`
|
|
|
|
 [](LICENSE.md)  
|
|
|
|
## 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](https://golang.org/doc/install)
|
|
|
|
### 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`.
|
|
|
|
```bash
|
|
go get -u github.com/rjNemo/go-wiki
|
|
```
|
|
|
|
## Usage
|
|
|
|
In the main application folder launch the server using
|
|
|
|
```bash
|
|
go run main.go
|
|
```
|
|
|
|
## Deployment
|
|
|
|
Add additional notes about how to deploy this on a live system
|
|
|
|
## Built With
|
|
|
|
- [Go](https://golang.org/) - Build simple, reliable, and efficient software
|
|
- [Bootstrap](https://getbootstrap.com/) - The most popular HTML, CSS, and JS library in the world
|
|
- [Quilljs](https://quilljs.com/) - Your powerful rich text editor
|
|
|
|
## Contributing
|
|
|
|
Please read [CONTRIBUTING.md](contributing.md) for details on our code of conduct, and the process for submitting pull requests to us.
|
|
|
|
## Versioning
|
|
|
|
We use [SemVer](https://semver.org/) for versioning. For the versions available, see the [CHANGELOG.md](CHANGELOG.md) and the [tags on this repository](https://github.com/rjNemo/go-wiki/tags).
|
|
|
|
## Authors
|
|
|
|
- **Ruidy Nemausat** - _Initial work_ - [rjNemo](https://github.com/rjNemo)
|
|
|
|
See also the list of [contributors](https://github.com/rjNemo/go-wiki/contributors) who participated in this project.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
|
|
|
|
## Acknowledgments
|
|
|
|
- Hat tip to anyone whose code was used
|
|
- Inspiration
|
|
- etc
|