namecheck

A simple CLI and server to check a name availability on Twitter and GitHub.

https://github.com/davidaparicio/namecheck

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary

Keywords

devsecops namecheck
Last synced: 4 months ago · JSON representation ·

Repository

A simple CLI and server to check a name availability on Twitter and GitHub.

Basic Info
  • Host: GitHub
  • Owner: davidaparicio
  • License: mit
  • Language: Go
  • Default Branch: main
  • Homepage:
  • Size: 427 KB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 4
  • Open Issues: 2
  • Releases: 6
Topics
devsecops namecheck
Created over 3 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Security

README.md

Namecheck

Namecheck logo

GoDoc Go Report Card codecov build Github GitLab Froggit

Security Rating Vulnerabilities License FOSSA Status Maintenance Twitter

Overview

A simple CLI and server to check a name availability on Twitter and GitHub.

Namecheck diagram

Source: https://gitdiagram.com/davidaparicio/namecheck

How to use it

If you have already Docker installed on your laptop

docker run davidaparicio/namecheck:<TAG/VERSION_LIKE_v0.0.5> <PSEUDO_TO_CHECK>

If not, you need Go and all dependencies

go run cmd/cli/main.go <PSEUDO_TO_CHECK>

or the server with

go run cmd/server/main.go

and check with a curl command curl http://localhost:8080/check?username=<PSEUDO_TO_CHECK>

For more information, you can see examples here

Remarks

Twitter checker is using a GCP Cloud Function, adding a network latency simulation, configurable through a parameter.

Server handles timeouts as recommended Filippo Valsorda on the Cloudflare blog (post 1 / post 2) and Ilija Eftimov.

ADR (Architecture decision record) about the usage of gorilla/mux can be found here.

Contribute

Works on my machine - and yours ! Spin up pre-configured, standardized dev environments of this repository, by clicking on the button below.

Open in Gitpod

Code coverage

coverage

Original project

Fork of the opensource project by @jub0bs, available on GitHub at https://github.com/jub0bs/namecheck.

License

Licensed under the MIT License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. You may obtain a copy of the License here.

If needed some help, there are a "Licenses 101" by FOSSA, a Snyk explanation of MIT license and a French conference talk by Jean-Michael Legait about licenses.

FOSSA Status

Owner

  • Name: David Aparicio
  • Login: davidaparicio
  • Kind: user
  • Location: Lyon
  • Company: OVHcloud

Seeking challenging projects ♟ I fell into it when I was a kid, so I can define my start in IT. Since then, new tech have been developed.. #onEstLaTech

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit (https://bit.ly/cffinit)
cff-version: 1.2.0
title: "David Aparicio's Namecheck"
message: "DevSecOps / Security by design applied to a Go project"
authors:
  - family-names: Aparicio
    given-names: David
    #orcid: https://orcid.org/0000-0003-4925-7248
repository-code: 'https://gitlab.com/davidaparicio/namecheck'
license: MIT
version: 0.0.2
#doi: 10.5281/zenodo.1234
date-released: 2022-08-31

GitHub Events

Total
  • Issues event: 2
  • Watch event: 1
  • Delete event: 30
  • Issue comment event: 63
  • Push event: 35
  • Pull request review event: 33
  • Pull request event: 63
  • Create event: 35
Last Year
  • Issues event: 2
  • Watch event: 1
  • Delete event: 30
  • Issue comment event: 63
  • Push event: 35
  • Pull request review event: 33
  • Pull request event: 63
  • Create event: 35

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 1
  • Total pull requests: 130
  • Average time to close issues: N/A
  • Average time to close pull requests: about 9 hours
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 2.0
  • Average comments per pull request: 1.47
  • Merged pull requests: 121
  • Bot issues: 0
  • Bot pull requests: 124
Past Year
  • Issues: 0
  • Pull requests: 36
  • Average time to close issues: N/A
  • Average time to close pull requests: about 5 hours
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.78
  • Merged pull requests: 33
  • Bot issues: 0
  • Bot pull requests: 36
Top Authors
Issue Authors
  • davidaparicio (1)
Pull Request Authors
  • dependabot[bot] (162)
  • davidaparicio (5)
  • fossabot (1)
Top Labels
Issue Labels
enhancement (1) good first issue (1) github_actions (1) closed-for-staleness (1)
Pull Request Labels
dependencies (162) github_actions (161) go (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
proxy.golang.org: github.com/davidaparicio/namecheck
  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 7.0%
Average: 8.2%
Dependent repos count: 9.3%
Last synced: 4 months ago

Dependencies

go.mod go
  • github.com/gorilla/mux v1.8.0
go.sum go
  • github.com/gorilla/mux v1.8.0
.github/workflows/close-stale-issues.yml actions
  • aws-actions/stale-issue-cleanup v6 composite
.github/workflows/closed-issue-message.yml actions
  • aws-actions/closed-issue-message v1 composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/autobuild v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/dependabot-automerge.yml actions
  • dependabot/fetch-metadata v1.3.6 composite
.github/workflows/docker-releaser.yml actions
  • actions/checkout v3 composite
  • docker/build-push-action v4.0.0 composite
  • docker/login-action v2 composite
  • docker/setup-buildx-action v2 composite
  • docker/setup-qemu-action v2 composite
.github/workflows/go-test.yml actions
  • actions/checkout v3 composite
  • actions/setup-go v3 composite
.github/workflows/golangci-lint.yml actions
  • actions/checkout v3 composite
  • actions/setup-go v3 composite
  • golangci/golangci-lint-action v3 composite
.github/workflows/goreleaser.yml actions
  • actions/checkout v3 composite
  • actions/setup-go v3 composite
  • anchore/sbom-action/download-syft v0.13.3 composite
  • docker/login-action v2 composite
  • docker/setup-qemu-action v2 composite
  • goreleaser/goreleaser-action v4 composite
  • sigstore/cosign-installer v2.8.1 composite
.github/workflows/gosec-analysis.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/upload-sarif v2 composite
  • securego/gosec v2.15.0 composite
.github/workflows/sonar-analysis.yml actions
  • SonarSource/sonarcloud-github-action master composite
  • actions/checkout v3 composite
Dockerfile docker
  • alpine latest build
  • scratch latest build