Start Open-Source Projects easily, quickly and conveniently with Open-Set-Go!
Open-Set-Go is the Open-Source Project Starting toolkit
for Open-Source Developers.
-
Log in with your GitHub ID(GitHub OAuth2)!
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. -
Create Repository
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! -
Add License
Allows you to determine and select a license based on the information provided about it. -
Add Pull-Request Template
Provides PR templates of several famous open-source projects so that users can create meaningful PR templates. -
Add Issue Templates
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 CONTRIBUTING.md
Provides references to Contributing.md for several well-known open-source projects, while also making it easy to create CONTRIBUTING.md through markdown previewer. -
Create README.md
Provides references to README.md for several well-known open-source projects, while also making it easy to create README.md through markdown previewer.
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.
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.
Can see our vision for the foreseeable future at our project's milestone.
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.
Supported Environment | Version | Description |
---|---|---|
Ubuntu OS | Ubuntu 22.04 LTS | Open-Set-Go_server was developed by Ubuntu OS |
Node.js | >= 18.x | @ocotokit/rest & styled-reset require >= node v18.x |
@nestjs/cli | 9.5.0 | Open-Set-Go_server is configured by NestJS |
yarn | 1.22.19 | Open-Set-Go server & client manage package with yarn |
-
Clone our Repository!
git clone --recursive https://github.com/AgainIoT/Open-Set-Go_server.git ###################################### # Open-Set-Go Repository Dependencies # # Open-Set-Go_server # ┗ environment-template # ######################################
-
Install the Development Environment
-
Install Node Dependencies
yarn install
-
Create your own github-oauth app
Follow the GitHub Docs to get Client ID & Client Secret.
If your Authorization URL should belocalhost:3000
! -
Create
.env
file at root to use secret environmenttouch .env
-
Fill in the
.env
file as follows.MONGODB_URI="<Your-MongoDB-URI-start-with-mongodb://>" CLIENT_ID="<Your-GitHub-OAuth-Client_ID>" CLIENT_SECRET="<Your-GitHub-OAuth-Client_Secret>" JWT_SECRET="<Any-JWT-Secret-You-Want>" JWT_EXPIRATION_TIME="<JWT-Expiration-Time-You-Want-default-18000>"
-
Start Open-Set-Go Server
yarn start
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 always welcome your contributions. Please see the CONTRIBUTING.md for how to contribute.
Also, we are recruiting collaborators, so if you are interested, please join our Slack!
Thank you to everyone who contributed to our project.
Open-Set-Go is released under Apache-2.0 License.
See the LICENSE file for details.