mirror of https://github.com/rjNemo/go-pass-gen synced 2026-06-06 02:46:40 +00:00

No description

Find a file

Ruidy 1458d55d32 add start server method		2022-06-02 18:36:26 +02:00
.github/workflows	add github actions (#4 )	2022-02-22 23:17:27 +01:00
api	add start server method	2022-06-02 18:36:26 +02:00
client	add start server method	2022-06-02 18:36:26 +02:00
cmd	♻️: shorten constructor name	2022-01-27 11:58:31 -04:00
passgen	♻️: shorten constructor name	2022-01-27 11:58:31 -04:00
.air.toml	simple client	2022-01-10 14:00:58 -04:00
.gitignore	simple client	2022-01-10 14:00:58 -04:00
.golangci.yml	chore: add golangci-lint nad ix makefile	2022-01-21 16:49:21 -04:00
CONTRIBUTING.md	docs: add more	2021-10-20 17:22:24 +02:00
Dockerfile	add Dockerfile	2022-06-02 18:19:37 +02:00
go.mod	add Dockerfile	2022-06-02 18:19:37 +02:00
go.sum	simple client	2022-01-10 14:00:58 -04:00
LICENSE.md	docs: add more	2021-10-20 17:22:24 +02:00
main.go	add start server method	2022-06-02 18:36:26 +02:00
Makefile	add Dockerfile	2022-06-02 18:19:37 +02:00
README.md	docs: add more	2021-10-20 17:22:24 +02:00

README.md

🍉 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.

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