# README
🍉 PassGen
Simple password generator.
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.
More documentation:
godoc -http=:6060
open http://localhost:6060/pkg/github.com/rjNemo/go-pass-gen/
Prerequisites
- Install a recent Golang version on the official website.
- Install
air
to enable auto reload during development using :
curl -sSfL https://raw.githubusercontent.com/cosmtrek/air/master/install.sh | sh -s -- -b $(go env GOPATH)/bin
Then initialize it in the project directory with:
air init
Installing
Install dependencies using:
go mod tidy
Run the development server with:
air
Running the tests
Explain how to run the automated tests for this system
Break down into end to end tests
Explain what these tests test and why
Give an example
And coding style tests
Explain what these tests test and why
Give an example
Deployment
Quality check before deployment.
Built With
Tool | Description |
---|---|
Go | Go is an open source programming language that makes it easy to build simple, reliable, and efficient software. |
Cobra | A Framework for Modern CLI Apps in Go |
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 tags on this repository.
Authors
- Ruidy - Initial work - Ruidy
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