Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 2.08 KB

README.md

File metadata and controls

78 lines (51 loc) · 2.08 KB
Raw

CTFDashB

Build Status Dependabot Status codecov GitHub tag (latest by date)

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, which includes docker-compose.

Installing

  1. Clone the git repo
git clone [email protected]:Abdulwahaab710/CTFDashB.git
  1. cd into the folder and generate your .env, by running the following script
./generate-env
  1. Build the containers
docker-compose build
  1. Create the database, run Migration and seed the database
docker-compose run web rake db:create db:migrate db:seed
  1. Run the application
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

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 file for details