https://github.com/abdulwahaab710/ctfdashb
Capture The Flag (CTF) dashboard 🚩
https://github.com/abdulwahaab710/ctfdashb
ctf ctf-framework ctf-platform ctf-scoreboard hacktoberfest
Last synced: 11 months ago
JSON representation
Capture The Flag (CTF) dashboard 🚩
- Host: GitHub
- URL: https://github.com/abdulwahaab710/ctfdashb
- Owner: Abdulwahaab710
- License: mit
- Created: 2017-10-18T20:25:58.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T23:36:53.000Z (over 3 years ago)
- Last Synced: 2025-07-02T05:05:19.336Z (11 months ago)
- Topics: ctf, ctf-framework, ctf-platform, ctf-scoreboard, hacktoberfest
- Language: Ruby
- Homepage:
- Size: 1.3 MB
- Stars: 6
- Watchers: 2
- Forks: 5
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CTFDashB
[](https://travis-ci.com/Abdulwahaab710/CTFDashB)
[](https://dependabot.com)
[](https://codecov.io/gh/Abdulwahaab710/CTFDashB)
CTFDashB is a Capture The Flag dashboard.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
Before we start you will need to have docker and docker-compose installed. You can download Docker Community Edition (CE) from [here](https://docs.docker.com/install/), which includes docker-compose.
### Installing
1. Clone the git repo
```sh
git clone git@github.com:Abdulwahaab710/CTFDashB.git
```
2. cd into the folder and generate your `.env`, by running the following script
```bash
./generate-env
```
3. Build the containers
```sh
docker-compose build
```
4. Create the database, run Migration and seed the database
```sh
docker-compose run web rake db:create db:migrate db:seed
```
5. Run the application
```sh
docker-compose up -d
```
## Contributing
To run the app in development mode, you will need to set the `RAILS_ENV` to `development`, or you can run the following script to generate your env with the correct environment
```sh
RAILS_ENV=development ./generate-env
```
### Running the tests
To run tests
```
docker-compose run web bundle exec rspec
```
#### And coding style (rubocop)
```
docker-compose run web bundle exec rubocop
```
To auto fix the violiation for rubocop
```
docker-compose run web bundle exec rubocop -a
```
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details