Skip to content

'Project Starting Toolkit' for OpenSource SW developers who can easily and easily start an Open Source project.

License

Notifications You must be signed in to change notification settings

Open-Set-Go/Open-Set-Go_server

 
 

Repository files navigation

Open-Set-Go_server

Open-Set-Go Logo

Start Open-Source Projects easily, quickly and conveniently with Open-Set-Go!

node Version License Sonar Cloud Scan Fossa License Scan Slack contributors Open-Set-Go_server stars Open-Set-Go_server stars


What is the Open-Set-Go?

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

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

  2. 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!

  3. Add License
    Allows you to determine and select a license based on the information provided about it.

  4. Add Pull-Request Template
    Provides PR templates of several famous open-source projects so that users can create meaningful PR templates.

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

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

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

Why Open-Set-Go?

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.

Vision of Open-Set-Go

Can see our vision for the foreseeable future at our project's milestone.

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.

Installation & Development Environment

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
  1. 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
    #
    ######################################
  2. Install the Development Environment

  3. Install Node Dependencies

    yarn install
  4. Create your own github-oauth app

    Follow the GitHub Docs to get Client ID & Client Secret.
    If your Authorization URL should be localhost:3000 !

  5. Create .env file at root to use secret environment

    touch .env
  6. 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>"
  7. Start Open-Set-Go Server

      yarn start

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

Contributing

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!

Contributors

Thank you to everyone who contributed to our project.

Open-Set-Go_server

Made with contrib.rocks

License

Open-Set-Go is released under Apache-2.0 License.
See the LICENSE file for details.

About

'Project Starting Toolkit' for OpenSource SW developers who can easily and easily start an Open Source project.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.2%
  • JavaScript 1.8%