Skip to content
This repository has been archived by the owner on Jun 16, 2022. It is now read-only.

Latest commit

 

History

History
122 lines (96 loc) · 5 KB

README.md

File metadata and controls

122 lines (96 loc) · 5 KB
Raw

owaspvit.org


Discord server Python Requirements Test Website status LICENSE Language count Contributions

About

owaspvit.org is the official Open Source initiative by the OWASP Student Chapter at VIT Chennai. It comprises two modules: A web application and a discord bot. These modules provide a wide range of functionalities for managing the chapter members.

  • Leaderboard for contribution tracking integrated with the discord bot
  • Digital Certificate locker integrated with the discord bot
  • Projects showcase integrated with the discord bot
  • CTF event management integrated with the discord bot
  • Gaming event management
  • Easy dockerized setup

Requirements

Setup

Open terminal and execute:

git clone https://github.com/owaspvit/owaspvit.org.git
cd owaspvit.org

Create config.toml:

# Keys
title = "owaspvit.org configuration"

# Web app configuration
[app]
secret = "your_web_app_secret"
github = "your_github_api_key"

# Database Configuration
[database]
mongoURI = "your_mongodb_connection_string"
firebaseDB = "your_firebase_db_url"
firebaseStorage = "your_firebase_storage_url"

# Bot configuration
[bot]
token = "your_discord_bot_token"
sheet = "your_google_sheet_id"
channel = "your_target_channel_id_as_integer"

# OWASP VITCC CTF Configuration
[ctf]
apiKey = "your_firebase_api_key"
authDomain = "your_firebase_auth_domain"
databaseURL = "your_firebase_db_url"
projectId = "your_firebase_project_id"
storageBucket = "your_firebase_storage_bucket_url"
messagingSenderId = "your_firebase_messaging_sender_id"
appId = "your_firebase_app_id"
measurementId = "your_firebase_measurement_id"
  • Rename the downloaded Firebase Realtime Database JSON SDK to firebase.json
  • Rename the downloaded Google Sheets JSON SDK to keys.json
  • Now copy the config.toml, firebase.json and keys.json to both the web and bot folders.

Starting up

Open terminal in the owaspvit.org project directory and execute the following:

docker-compose up

Stopping

Open terminal in the owaspvit.org project directory and execute the following:

docker-compose down

Discord Bot Information

You can view the OWASP VITCC Bot commands by executing !owasp help

Links

Contributing Guidelines

Before creating an issue, please ensure that it hasn't already been reported/suggested.

The issue tracker is only for bug reports and enhancement suggestions. If you have a question, please ask it in the Discord server instead of opening an issue – you will get redirected there anyway.

If you wish to contribute to the owaspvit.org codebase or documentation, feel free to fork the repository and submit a pull request.

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our Discord Server.