-
-
Notifications
You must be signed in to change notification settings - Fork 157
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Updated README.md * Updated README.md #1 * Updated README.md #2 * Updated README.md #3 * Updated README.md #4 * Updated README.md #5 * Updated README.md #6 * Updated README.md #7 * Updated README.md #8 * Updated README.md #9 * Updated README.md #10 * Updated README.md #11 * Updated README.md #12 * Updated README.md #12
- Loading branch information
1 parent
afaf511
commit 1d795b7
Showing
1 changed file
with
148 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,150 @@ | ||
https://www.github.com/OWASP/BLT | ||
https://www.github.com/OWASP/BLT-Flutter | ||
https://www.github.com/OWASP/BLT-Extension | ||
https://www.github.com/OWASP/BLT-Bacon | ||
https://www.github.com/OWASP/BLT-Action | ||
<h1 align="center"> OWASP BLT </h1> | ||
|
||
|
||
https://owasp.org/www-project-bug-logging-tool/ | ||
<p align="center"><a href="https://github.com/OWASP/BLT/actions" target="__blank"><img alt="Build" src="https://github.com/OWASP/BLT/actions/workflows/auto-merge.yml/badge.svg"></a> <a href="https://github.com/OWASP/BLT/blob/main/LICENSE.md"><img src="https://img.shields.io/badge/license-AGPL--3.0-blue"></a> | ||
<a href="https://github.com/OWASP/BLT" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/OWASP/BLT?style=social"></a></p> | ||
|
||
------ | ||
|
||
|
||
|
||
**Report issues and get points, companies are held accountable.** | ||
|
||
|
||
|
||
- OWASP BLT is a bug logging tool to report issues and get points, companies are held accountable. | ||
|
||
|
||
|
||
- Users will get rewards/points for reporting bugs on Organizations / Companies. | ||
|
||
|
||
|
||
- Organizations / Companies can launch their bug hunt programs with prize pools. | ||
|
||
|
||
|
||
- Read more about [BLT](https://owasp.org/www-project-bug-logging-tool/) | ||
|
||
|
||
|
||
|
||
# Development | ||
|
||
|
||
|
||
### Setting Up Development Server | ||
|
||
|
||
|
||
|
||
|
||
Please follow the development server setup procedure [here](https://github.com/OWASP/BLT/blob/main/Setup.md). Currently, development server can be installed using docker or vagrant. You can also use virtualenv or pipenv install, pipenv shell and then continue with the remaining instructions. | ||
|
||
|
||
|
||
|
||
|
||
### Documentation | ||
|
||
|
||
|
||
|
||
|
||
- use the [Installation Docs ](https://github.com/OWASP/BLT/blob/main/Setup.md) to get started. | ||
|
||
|
||
|
||
- Swagger API Documentations can be found at the root domain /swagger/ | ||
|
||
|
||
|
||
- Postman API Documentations: [Postman Docs](https://documenter.getpostman.com/view/19782933/VUqpscyV). | ||
|
||
|
||
|
||
|
||
|
||
### Resources | ||
|
||
|
||
|
||
|
||
|
||
- Join the [OWASP Slack Channel](https://owasp.org/slack/invite) and ask questions at **#project-blt** | ||
|
||
|
||
|
||
- Github activity can be seen in Slack **#blt-github**. | ||
|
||
|
||
|
||
- Figma designs for web and flutter app are available [here](https://www.figma.com/file/s0xuxeU6O2guoWEfA9OElZ/Design) | ||
|
||
|
||
|
||
|
||
|
||
### Other BLT Projects | ||
|
||
|
||
|
||
- [OWASP/BLT](https://www.github.com/OWASP/BLT) | ||
|
||
|
||
|
||
- [OWASP/BLT-Flutter](https://www.github.com/OWASP/BLT-Flutter) | ||
|
||
|
||
|
||
- [OWASP/BLT-Extension](https://www.github.com/OWASP/BLT-Extension) | ||
|
||
|
||
|
||
- [OWASP/BLT-Bacon](https://www.github.com/OWASP/BLT-Bacon) | ||
|
||
|
||
|
||
- [OWASP/BLT-Action](https://www.github.com/OWASP/BLT-Action) | ||
|
||
|
||
|
||
|
||
|
||
### Coding style guide | ||
|
||
|
||
|
||
|
||
|
||
Please follow the [black](https://github.com/psf/black) code style for the project. It helps us in keeping the codebase consistent and improves readability for other developers. | ||
|
||
|
||
|
||
|
||
|
||
### License | ||
|
||
|
||
|
||
The BLT code is released under [GNU Affero General Public License v3.0 (AGPL-3.0)](https://github.com/OWASP/BLT/blob/master/LICENSE). | ||
|
||
|
||
|
||
|
||
|
||
## Notes | ||
|
||
|
||
|
||
|
||
|
||
- If you find a bug or have an improvement, use BLT to report it! | ||
|
||
|
||
|
||
- for each new issue, create a new branch with issue-382 or similar matching the issue number - when you commit add fixes #288 to link the issue to the pull request | ||
|
||
|
||
|
||
- to take a github issue type a comment that says "assign to me" or /assign and it will assign it to you. |