Skip to content
Permalink
Browse files

doc(README): update README.md and CONTRIBUTING.md

  • Loading branch information...
wei committed Mar 1, 2019
1 parent 937cbb2 commit fadd7d0ea0b915483cc432e64115e216444983d9
Showing with 204 additions and 188 deletions.
  1. +40 −68 CONTRIBUTING.md
  2. +1 −1 LICENSE
  3. +36 −71 README.md
  4. +84 −0 docs/CONTRIBUTING-zh.md
  5. +43 −48 docs/README-zh.md
@@ -1,102 +1,74 @@
# 介绍
<p align="right">English | <a href="./docs/CONTRIBUTING-zh.md">中文</a></p>

### 一起来贡献super-inspire 吧 !
# Contributing

>首先感谢您关注super-inspire的发展, 这里会告诉您如何参与共同构建更好的super-inspire!
### Commit message

super-inspire是一个基于docker container, web-shell 等可以在web界面直接启动一个虚拟linux环境用于:
* One change per commit

* 开发灵感验证
Say you have the following changes:

* 技术演讲, 演示
* a bug fix
* a new feature development

* linux新手学习
DO commit after each task

* 等等...
DO NOT bundle multiple changes in one commit

的开源项目
* Commit message convention

This project follows AngularJS's [commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)

# 贡献 指南
`<type>(<scope>): <subject>`

> 按照共同的贡献指南才能更好的参与贡献和持续推进整个项目发展.
`type` must be one of:
* feat: A new feature
* fix: A bug fix
* docs: Documentation only changes
* style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
* refactor: A code change that neither fixes a bug nor adds a feature
* perf: A code change that improves performance
* test: Adding missing or correcting existing tests
* chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

examples:

* docs(README): add sponsor link

### Commit message 指南
* style(file.py): fix syntax error

* 尽量 "一次修改" 就提交 "一次message"
* fix(api): fix create docker container bug

例如当前有如下工作:

* 一个bug需要修复
* 一个新feature开发
### Issue

建议选择一个更为重要的工作 先行处理, 并在通过测试后进行commit
* Provide detailed environment information

而不是在一次commit中完成多项工作( 既完成bug修复, 同时也完成新feature开发 )
* Provide detailed steps to reproduce

* Commit message 格式
* Provide as much information as possible for the error (e.g. error message, stacktrace, etc)

推荐使用如下的commit message格式, 请注意该格式不是任何其他开源项目所共识的格式, 仅仅为了统一super-inspire的标准commit message 格式.

### Pull request

* Keep commit history clean

[main modify file/directory name] simple description
* Make sure python code passes pycodestyle tests

* Include unit tests

* Explain scope and reason for the change

例如:
* All pull requests are required to be reviewed

* 简单修改

[README.md] Add sponsor link
### Join instantbox

[inspire.py] Fix syntax error
Want to instantbox team? We'd love to have you.

Please send your request to team@instantbox.org with your information and areas of intended contribution.

* 复杂修改

[API] Fix create docker container bug

​ -. modify API/create.py

​ -. modify API/status.py

​ -. ...


### Issue 指南

* 尽可能提供足够的运行环境信息

* 尽可能提供运行时问题

* 尽可能提供完整打印的错误堆栈信息


### pull request 指南

* 建议通过fork项目, 并在完成贡献后通过pull request来合并到code主线

* 尽量保持 commit history 干净完整并通过单元测试后再行提交

* 尽量能够描述修改内容和原因

* 每一个pr需要经过至少一次他人的review


### 加入super-inspire

想加入super-inspire团队? 非常欢迎!

请将您的请求发送到 zhuyuefeng0@gmail.com 并注明请求和需求即可~

欢迎你参与super-inspire, 同时希望super-inspire能帮助你成长, 不过作为一个穷穷的小开源组织(哭), 我们暂时不能提供任何经济上的回馈, 还请理解> . <



### 其他疑问?

欢迎直接提起issue来砸向我们呀~
### Other questions?

Feel free to join us on [telegram](https://t.me/joinchat/HtYtxRSerOwrMLg_2_wZTQ) or submit an issue.
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 Super-Inspire
Copyright (c) 2019 instantbox

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
107 README.md
@@ -1,115 +1,80 @@
<div align="center">

# instantbox

English | [中文](./docs/README-zh.md)
<p align="right">English | <a href="./docs/README-zh.md">中文</a></p>

<div align="center">

![logo](https://user-images.githubusercontent.com/5880908/53614582-6ebdfc80-3ba8-11e9-819e-d96a3f7c22f0.png)

### Get a clean, out of the box, temporary Linux in under 30s.

What's a instantbox? It allows you to access the web to operate an out-of-the-box Linux system in less than 30 seconds using only a browser. Of course, the "system" here is implemented with docker, so it cannot be considered as a more isolated virtualization system like KVM.

![](./terminal.png)
# instantbox

Join discuss in telegram group: https://t.me/joinchat/HtYtxRSerOwrMLg_2_wZTQ
Get a clean, ready-to-go Linux box in seconds.

[![Travis CI](https://badgen.net/travis/instantbox/instantbox)](https://travis-ci.com/instantbox/instantbox)
[![Docker](https://badgen.net/badge//instantbox%2Finstantbox?icon=docker)](https://hub.docker.com/r/instantbox/instantbox)
![Python 3.6](https://badgen.net/badge/python/3.6/3776ab)
![Code Style Pep8](https://badgen.net/badge/code%20style/pep8/ffd343)
[![Chat on Telegram](https://badgen.net/badge/chat/on%20telegram/0088cc)](https://t.me/joinchat/HtYtxRSerOwrMLg_2_wZTQ)
[![MIT](https://badgen.net/badge/license/MIT/3da639)](LICENSE)

</div>

[![Backers on Open Collective](https://opencollective.com/super-inspire-end/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](https://opencollective.com/super-inspire-end/sponsors/badge.svg)](#sponsors)

## Current status and acceptance of sponsorship

Currently, the server resources are all provided by myself at my own expense.
In order to provide a better experience for everyone, we accept personal/corporate server resources (!!Urgent need!!!!!) and promotional sponsorship, but do not accept any financial support
If instantbox can help you and provide sponsorship with conditions and interests, I really hope you can get in touch with me. Please send me an email to zhuyuefeng0@gmail.com. Thank you very much.

- start domestic temporary server has resumed, but still behind the wall of temporary server performance, request address is http://60.190.81.133:8888
- the newly started temporary test server outside the wall has good performance and requests the address
- http://35.220.214.188:8888/

In the case of over the GFW(Great Firewall of China), it is preferred to try using a foreign temporary test server

## Introduction

** So what can a instantbox do? **
### What is instantbox?

1. When you need a clean Linux environment for your presentation, you can try to use it to give a presentation to the audience
It's a project that spins up temporary Linux systems with instant webshell access from any browser.

2. When the school teaching /LUG activity needs everyone to use linux system, you can let students who can't install Linux temporarily experience the charm of Linux

3. When you have an inspiration and want to try it in a clean environment, why not use a instantbox out of the box?
### What can an instantbox do?

4. When I'm outside and I don't have a device , the instantbox allows me to manage servers on any device.
1. provides a clean Linux environment for a presentation
2. let students experience the charm of Linux at your school or your next LUG meet
3. run with an inspiration in a clean environment
4. manage servers from any device
5. experiment with an open source project
6. test software performance under resource constraints

5. See a project on GitHub that you're very interested in trying, but was put off by the fact that it's running on Linux?instantbox allows you to get a clean environment in 30s, and you can even open a port for testing programs that need ports (for instance,Develop port 80 for testing).
and more! ideas are endless...

6. instantbox due to use docker as its support, so we use cgroups to manage performance. If you want to test whether one of your apps can run under a certain performance, it is a good choice to use instantbox

More useful things of instantbox are you thinking about
### Which Linux distributions are available?

In addition, we are planning to develop persistence containers so that some user containers can be destroyed without closing the web page, and they can still be used for a short period of time (Containers that do not support external development).
We currently supports various versions of Ubuntu, CentOS, Arch Linux, Debian, Fedora and Alpine.

---

## Screenshot of the web interface

![](./demo/demo.jpg)
## Quickstart

## QuickStart/quickStart
Go to http://35.220.214.188:8888 and follow instructions

To access the temporary server address, you can choose a favorite system here, and then the system will automatically create the system's container, and automatically open a new web page into the web shell interaction.
![Demo screenshot](https://user-images.githubusercontent.com/5880908/53613565-6237a500-3ba4-11e9-9e39-8ea48cee73ee.png)

- currently support Ubuntu14.04, 16.04, 18.04;CentOS6.10;CentOS7;Alpine Latest.
- please note that pop-up windows are allowed.

## How to deploy instantbox?
## Deploy

If you think the experience provided by the official server is too slow, welcome to deploy one yourself! It's very easy to deploy a instantbox, and you need to have the following environment:

1. Linux system with docker, Ubuntu:16.04 is recommended
Prerequisite: docker [[More Information]](https://docs.docker.com/install/)

```bash
mkdir instantbox && cd $_
bash <(curl -sSL https://raw.githubusercontent.com/instantbox/instantbox/master/init.sh)
```

Now you can use the local instantbox! 
By default, please visit localhost:8888 to test.

## The questions?

If you have any questions, please submit the issue, we will check and reply soon.
Thanks a lot to the **ttyd** project of tsl0922 . It was with it that instantbox was able to complete the components of webshell.

I wish you greater access to Linux and open source through the instantbox, which is our biggest dream.
## Questions

## Contributors
Please submit an issue or join the conversation on [telegram](https://t.me/joinchat/HtYtxRSerOwrMLg_2_wZTQ).

This project exists thanks to all the people who contribute.
<a href="https://github.com/super-inspire/super-inspire-end/graphs/contributors"><img src="https://opencollective.com/super-inspire-end/contributors.svg?width=890&button=false" /></a>

## Donations

## Backers
We are in urgent need for donations in the form of server resources. Please contact us at team@instantbox.org if you are able to help. We appreciate it!

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/super-inspire-end#backer)]

<a href="https://opencollective.com/super-inspire-end#backers" target="_blank"><img src="https://opencollective.com/super-inspire-end/backers.svg?width=890"></a>
## Credits

* [tsl0922/ttyd](https://github.com/tsl0922/ttyd) - webshell

## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/super-inspire-end#sponsor)]
## License

<a href="https://opencollective.com/super-inspire-end/sponsor/0/website" target="_blank"><img src="https://opencollective.com/super-inspire-end/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/super-inspire-end/sponsor/1/website" target="_blank"><img src="https://opencollective.com/super-inspire-end/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/super-inspire-end/sponsor/2/website" target="_blank"><img src="https://opencollective.com/super-inspire-end/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/super-inspire-end/sponsor/3/website" target="_blank"><img src="https://opencollective.com/super-inspire-end/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/super-inspire-end/sponsor/4/website" target="_blank"><img src="https://opencollective.com/super-inspire-end/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/super-inspire-end/sponsor/5/website" target="_blank"><img src="https://opencollective.com/super-inspire-end/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/super-inspire-end/sponsor/6/website" target="_blank"><img src="https://opencollective.com/super-inspire-end/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/super-inspire-end/sponsor/7/website" target="_blank"><img src="https://opencollective.com/super-inspire-end/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/super-inspire-end/sponsor/8/website" target="_blank"><img src="https://opencollective.com/super-inspire-end/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/super-inspire-end/sponsor/9/website" target="_blank"><img src="https://opencollective.com/super-inspire-end/sponsor/9/avatar.svg"></a>
[MIT](LICENSE)
@@ -0,0 +1,84 @@
<p align="right">中文 | <a href="../CONTRIBUTING.md">English</a></p>

### 一起来贡献 instantbox 吧!

> 首先感谢您关注 instantbox 的发展, 这里会告诉您如何参与共同构建更好的 instantbox !

# 贡献指南

> 按照共同的贡献指南才能更好的参与贡献和持续推进整个项目发展

### Commit message 指南

* 尽量 "一次修改" 就提交 "一次 message"

例如当前有如下工作:

* 一个 bug 需要修复
* 一个新 feature 开发

建议选择一个更为重要的工作先行处理,并在通过测试后进行 commit

而不是在一次 commit 中完成多项工作(既完成 bug 修复, 同时也完成新 feature 开发)

* Commit message 格式

项目使用 AngularJS 的 [commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) [[中文]](http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html)

`<type>(<scope>): <subject>`

其中 `type` 有以下可选项:
* feat:新功能(feature)
* fix:修补bug
* docs:文档(documentation)
* style: 格式(不影响代码运行的变动)
* refactor:重构(即不是新增功能,也不是修改bug的代码变动)
* perf:提升性能
* test:增加测试
* chore:构建过程或辅助工具的变动

例如:

* docs(README): add sponsor link

* style(file.py): fix syntax error

* fix(api): fix create docker container bug


### Issue 指南

* 尽可能提供足够的运行环境信息

* 尽可能提供运行时问题

* 尽可能提供完整打印的错误堆栈信息


### Pull request 指南

* 尽量保持 commit history 干净完整

* 确认代码风格通过 pycodestyle 验证

* 编写并确认代码通过单元测试

* 尽量能够描述修改内容和原因

* 每一个 PR 需要经过至少一次他人的 review


### 加入 instantbox

想加入 instantbox 团队? 非常欢迎!

请将您的请求发送到 team@instantbox.org 并注明请求和需求即可~

欢迎你参与 instantbox , 同时希望 instantbox 能帮助你成长, 不过作为一个穷穷的小开源组织(哭), 我们暂时不能提供任何经济上的回馈, 还请理解 > . <


### 其他疑问?

欢迎前往 [telegram](https://t.me/joinchat/HtYtxRSerOwrMLg_2_wZTQ) 参与交流或者直接提起 issue 来砸向我们呀~
Oops, something went wrong.

0 comments on commit fadd7d0

Please sign in to comment.
You can’t perform that action at this time.