Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MyIP #630

Open
7 tasks done
jason5ng32 opened this issue Mar 23, 2024 · 7 comments
Open
7 tasks done

Add MyIP #630

jason5ng32 opened this issue Mar 23, 2024 · 7 comments
Labels
addition Adding new software to the list needs to mature Project is younger than 4 months

Comments

@jason5ng32
Copy link

jason5ng32 commented Mar 23, 2024

Thanks for taking the time to suggest an addition to awesome-selfhosted!

Please fill out information below (all fields are mandatory unless noted otherwise):

# software name
name: "MyIP"
# URL of the software project's homepage
website_url: "https://ipcheck.ing"
# URL where the full source code of the program can be downloaded
source_code_url: "https://github.com/jason5ng32/MyIP"
# description of what the software does, shorter than 250 characters, sentence case
description: "All in one IP Toolbox. Easy to check what's your IPs, IP geolocation, check for DNS leaks, examine WebRTC connections, speed test, ping test, MTR test, check website availability and more."
# list of license identifiers, see https://github.com/awesome-selfhosted/awesome-selfhosted-data/blob/master/licenses.yml for the full list of licenses
licenses:
  - MIT
# list of languages/platforms, see https://github.com/awesome-selfhosted/awesome-selfhosted-data/tree/master/platforms for the full list of platforms
platforms:
  - Nodejs
  - Docker
# list of tags (categories), see https://github.com/awesome-selfhosted/awesome-selfhosted-data/tree/master/tags for the full list of tags
tags:
  - Network Tools
  - Monitoring
  - Automation
# (optional, true/false, default false) whether the software depends on a third-party service outside the user's control
depends_3rdparty: true
# (optional) link to an interactive demo of the software
demo_url: "https://ipcheck.ing"

To ensure your issue is dealt with swiftly, please check the following (check the boxes [x]):

  • Submit one item per pull issue. This eases reviewing and speeds up inclusion.
  • You have searched the repository for any relevant issues or PRs, including closed ones.
  • Any software you are adding is not already listed at any of awesome-sysadmin, staticgen.com, staticsitegenerators.net, dbdb.io.
  • Any software project you are adding to the list is actively maintained.
  • Any software project you are adding was first released more than 4 months ago.
  • Any software project you are adding has working installation instructions.
  • If you are adding software forked from another active project, please provide/link to a clear list of differences between both.
@jason5ng32 jason5ng32 added the addition Adding new software to the list label Mar 23, 2024
@kokomo123
Copy link
Collaborator

kokomo123 commented Mar 24, 2024

Unfortunately, it seems there are no tagged releases. Rather then pull from main/latest all the time, users should be able to verify that its stable and have changelogs, etc. We can check back in around 4 months from the first stable tagged release.

If i'm wrong, feel free to remove the needs to mature tag others, thanks!

@kokomo123 kokomo123 added the needs to mature Project is younger than 4 months label Mar 24, 2024
@jason5ng32
Copy link
Author

Thank you for your reply and for understanding my concerns.

My program runs directly using the JS source code and does not require complex binary compilation, so there's no need to specifically output a distribution version. In fact, if a distribution is forced, the code in the main branch remains the same.

Additionally, the changelog for each version is clearly stated within the program, specifically in /src/locales/en.json, and it is also listed in the About section on the official website.

My code has been released for 5 months now, and if possible, I hope you will consider including it again.

Thank you.

image

@kokomo123
Copy link
Collaborator

kokomo123 commented Apr 15, 2024

Thanks for weighing in, as there is a changelog i'm sure that's sufficient enough and its visible for users to consider updating their code to the latest version. I shall remove the label and just double confirm
CC: @nodiscc is this sufficient enough for inclusion as there's an online changelog instead of a GH one?

@kokomo123 kokomo123 removed the needs to mature Project is younger than 4 months label Apr 15, 2024
@nodiscc
Copy link
Member

nodiscc commented Apr 15, 2024

@jason5ng32 what about starting using git tags right now? For example this commit would have the git tag 3.6 in addition to the changelog entry.

This would make it easy for users to deploy a particular version, and upgrade when they feel like it/after reviewing changes, instead of always running the latest master version, which is subject to change without warning, may contain breaking changes, etc.

@nodiscc nodiscc added the needs to mature Project is younger than 4 months label Apr 15, 2024
@jason5ng32
Copy link
Author

jason5ng32 commented Apr 16, 2024

Hi @nodiscc

Thank you for your suggestion. I find it very valuable. While downloading code directly from the main branch is indeed convenient, creating different versions does help users distinguish between features and choose their preferred version to use.

Following your advice, I have created the release for version 3.6: https://github.com/jason5ng32/MyIP/releases/tag/v3.6 .

I hope you will consider my project again. Over the past few months, my program has gained many stars and forks, and many people have created their own hosted versions using my code.

Thank you.

@jason5ng32
Copy link
Author

Can you reconsider my project? @nodiscc @kokomo123

@kokomo123
Copy link
Collaborator

kokomo123 commented Apr 19, 2024

We will include your project after it's been around 4 months since you've now started creating git tags, so feel free to check in/around August 18th, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addition Adding new software to the list needs to mature Project is younger than 4 months
Development

No branches or pull requests

3 participants