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

README.md generated by Open-Set-Go 🚀 #59

Merged
merged 2 commits into from
Oct 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/images/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/roadmap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
80 changes: 48 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,85 @@
# Open-Set-Go

<p align="center">
<a href="https://open-set-go.netlify.app/" target="blank"><img src="./.github/images/Open-Set-Go.png" width="200" alt="Open-Set-Go Logo" /></a>
<a href="https://www.open-set-go.com" target="blank"><img src="https://github.com/AgainIoT/Open-Set-Go/blob/main/.github/images/Open-Set-Go.png?raw=true" width="200" alt="Open-Set-Go Logo" /></a>
</p>

<p align="center">
Start Open-Source Projects easily, quickly and conveniently with <a href="https://open-set-go.netlify.app/" target="blank">Open-Set-Go</a>!
Manage Open-Source Projects from the beginning with 'Open-Source Management Platform', <a href="https://www.open-set-go.com" target="blank">Open-Set-Go</a>! 🚀
</p>

<p align="center">
<a href="https://github/AgainIoT/Open-Set-Go"><img src="https://img.shields.io/node/v-lts/%40octokit%2Frest" alt="node Version" /></a>
<a href="/LICENSE"><img src="https://img.shields.io/github/license/AgainIoT/Open-Set-Go" alt="License" /></a>
<a href="https://github/AgainIoT/Open-Set-Go"><img src="https://img.shields.io/node/v-lts/%40octokit%2Frest?logo=node.js&label=node" alt="node Version" /></a>
<a href="https://sonarcloud.io/summary/new_code?id=AgainIoT_Open-Set-Go_server" target="_blank"><img src="https://sonarcloud.io/api/project_badges/measure?project=AgainIoT_Open-Set-Go_server&metric=alert_status" alt="Sonar Cloud Scan" /></a>
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2FAgainIoT%2FOpen-Set-Go?ref=badge_shield" target="_blank"><img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2FAgainIoT%2FOpen-Set-Go.svg?type=shield&issueType=license" alt="Fossa License Scan" /></a>
<a href="https://join.slack.com/t/open-set-go/shared_invite/zt-21jwlzs9g-qrajfUblcCtmCqAy0Xxj8w" target="_blank"><img src="https://img.shields.io/badge/Slack-online-brightgreen.svg" alt="Slack"/></a>
<a href="https://github.com/AgainIoT/Open-Set-Go/graphs/contributors" target="_blank"><img src="https://img.shields.io/github/contributors-anon/AgainIoT/Open-Set-Go" alt="contributors" /></a>
<a href="https://github.com/AgainIoT/Open-Set-Go"><img src="https://img.shields.io/github/last-commit/AgainIoT/Open-Set-Go" alt="Open-Set-Go stars" /></a>
<a href="https://github.com/AgainIoT/Open-Set-Go"><img src="https://img.shields.io/github/stars/AgainIoT/Open-Set-Go" alt="Open-Set-Go stars" /></a>
<a href="https://www.open-set-go.com"><img src="https://img.shields.io/w3c-validation/html?targetUrl=https%3A%2F%2Fwww.open-set-go.com&logo=w3c&label=validation" alt="w3c validation check" /></a>
<a href="https://www.open-set-go.com"><img src="https://img.shields.io/netlify/8a6fd2e8-3678-439f-9ba4-8aec0cb2f9ad?logo=netlify" alt="Netlify status" /></a>
<a href="https://join.slack.com/t/open-set-go/shared_invite/zt-21jwlzs9g-qrajfUblcCtmCqAy0Xxj8w" target="_blank"><img src="https://img.shields.io/badge/slack-online-brightgreen.svg?logo=slack" alt="Slack"/></a>
<a href="https://github.com/AgainIoT/Open-Set-Go"><img src=" https://img.shields.io/github/v/release/AgainIoT/Open-Set-Go?logo=github" alt="github release" /></a>
<a href="https://github.com/AgainIoT/Open-Set-Go"><img src="https://img.shields.io/github/release-date/AgainIoT/Open-Set-Go?color=blue&logo=github" alt="github last release date" /></a>
<a href="/LICENSE"><img src="https://img.shields.io/github/license/AgainIoT/Open-Set-Go?logo=github&color=blue" alt="github License" /></a>
<a href="https://github.com/AgainIoT/Open-Set-Go/graphs/contributors" target="_blank"><img src="https://img.shields.io/github/contributors-anon/AgainIoT/Open-Set-Go?logo=github&color=blue" alt="github contributors" /></a>
<a href="https://github.com/AgainIoT/Open-Set-Go"><img src="https://img.shields.io/github/stars/AgainIoT/Open-Set-Go?logo=github" alt="github stars" /></a>
<a href="https://github.com/AgainIoT/Open-Set-Go"><img src=" https://img.shields.io/github/discussions/AgainIoT/Open-Set-Go?logo=github&color=blue
" alt="github discussions" /></a>
</p>

<h4 align="center">
<p>
<b>English</b> |
<a href="https://github.com/AgainIoT/Open-Set-Go/">한국어</a>
</p>
</h4>

_<div align=center>Please contribute to translation so that more people can use this service!</div>_

<br>

## What is the **Open-Set-Go**?

**Open-Set-Go** is the `Open-Source Project Starting toolkit` for Open-Source Developers.

0. Log in with your GitHub ID(GitHub OAuth2)! <br>
This project is subordinate to GitHub and is being developed on the basis of launching an Open-Source project on GitHub. Therefore, you can log-in to Open-Set-Go with your GitHub ID.
**Open-Set-Go** is the `Open-Source Management Platform` for Open-Source Developers. Open-Set-Go provides the creation of new open-source projects and operational review for existing projects.

1. Create Repository <br>
Create a repository to start a new open-source project. You can choose the environment(_e.g., programming language, framework, gitignore, etc._) for your project. Then, your project's environment will be set!
**Open-Set-Go** is dependent on **:octocat: GitHub**, and the GitHub OAuth 2.0 authorization process allows you analyze, create, and requests Pull-Request from your(or your organization's) GitHub repository.

2. Add License <br>
Allows you to determine and select a license based on the information provided about it.
- Create [Pull-Request Template](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request), [Issue Templates](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue), [README.md](https://docs.github.com/ko/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes), [CONTRIBUTING.md](https://mozillascience.github.io/working-open-workshop/contributing/) with Open-Set-Go!

3. Add Pull-Request Template <br>
Provides PR templates of several famous open-source projects so that users can create meaningful PR templates.
- Open-Set-Go provides documents from many well-known open-source projects and allows them to be modified with markdown editor!

4. Add Issue Templates <br>
Provides Issue Template references for several well-known open-source projects for different situations, making it easy for users to create an Issue Template.
- Create beautiful documents easily and simply using Open-Set-Go's personalized template!

5. Create CONTRIBUTING.md <br>
Provides references to Contributing.md for several well-known open-source projects, while also making it easy to create CONTRIBUTING.md through markdown previewer.
<br>

6. Create README.md <br>
Provides references to README.md for several well-known open-source projects, while also making it easy to create README.md through markdown previewer.
<img src="./.github/images/overview.png" alt="overview">

## Why **Open-Set-Go**?

### For starting new Open-Source Project

It is not just to create a Source-Open Project, but to create a contribution-friendly environment and create an environment where communication between developers and contributors is smooth to create sustainable open source projects. <br>
In addition, **Open-Set-Go** makes it easy, fast, and simple to build a contribution-friendly environment at the start of an open-source project.

### For continuing the open-source project

It provides an open-source operation review feature for three areas for the open-source project in progress.

- Template: Ensure that there are templates required to sustain open source. Using the features of Open-Set-Go, additional templates can be created to make pull-request requests.

- Security: Check whether the features provided by GitHub for the security of open-source projects are activated.

- Community: Check the elements needed to build an open-source community.

## Vision of **Open-Set-Go**

Can see our vision for the foreseeable future at our project's milestone. <br>
Can see our vision for the foreseeable future at [our project's milestone](https://github.com/AgainIoT/Open-Set-Go/milestones) & [our wiki](https://github.com/AgainIoT/Open-Set-Go/wiki). <br>

- <a href="https://github.com/AgainIoT/Open-Set-Go/milestones">Open-Set-Go</a>
- <a href="https://github.com/AgainIoT/Open-Set-Go_client/milestones">Open-Set-Go client</a>
- <a href="https://github.com/AgainIoT/Open-Set-Go_server/milestones">Open-Set-Go server</a>
Open-Set-Go is moving toward an Open-Source project management platform that can manage more parts. Join [Slack](https://join.slack.com/t/open-set-go/shared_invite/zt-21jwlzs9g-qrajfUblcCtmCqAy0Xxj8w) if you want to join us!

### Final Vision of Open-Set-Go

Open-Set-Go makes it easy, fast and simple to start an Open-Source project, while also sharing your own contribution environment and becoming a community driving the Open-Source trend. _Like GitHub._

<img src="./.github/images/roadmap.png">

## Installation & Development Environment

| Supported Environment | Version | Description |
Expand All @@ -83,7 +100,6 @@ git clone --recursive https://github.com/AgainIoT/Open-Set-Go.git
# ┣ Open-Set-Go.io
# ┣ Open-Set-Go_client
# ┗ Open-Set-Go_server
# ┗ environment-template
#
######################################
```
Expand All @@ -92,9 +108,9 @@ See more details at Open-Set-Go's <a href="https://github.com/AgainIoT/Open-Set-

## Documentation

We are conducting documentation at Open-Set-Go.io. Please refer to the following. _You can see our technical blog & showcase on Open-Set-Go.io_
We are conducting documentation at Open-Set-Go.io. Please refer to the following. _You can see our technical blog & showcase & documentation on Open-Set-Go.io_

- <a href="">Open-Set-Go.io</a>
- <a href="https://docs.open-set-go.com">Open-Set-Go.io</a>

## Contributing

Expand All @@ -103,7 +119,7 @@ Also, we are recruiting collaborators, so if you are interested, please join our

## Contributors

Thank you to everyone who contributed to our project.
Thank you to everyone who contributed to our project. Any contribution you make will be reflected on [RELEASE.md](./RELEASE.md)

### Open-Set-Go

Expand Down