Skip to content

Fall 2021 SWE6763 Term Project: A simple NQueens algorithm visualized utilizing Unity

License

Notifications You must be signed in to change notification settings

JohnMurwin/NQueensSimulation

Repository files navigation

License CI Status Build

Quality Gate Status Coverage Vulnerabilities Bugs Code Smells


Logo

NQueens Simulation & Game CI Integration Study

This Fall Semester 2021 Final Project for Software Eval. and Measurement at Kennesaw State Univserity. This project serves to ultimately provide a framework for a Software Evalutation study on the Continous Integration tool "SonarCloud" and accompanied by a written report.
Explore the Docs »

View Itch.io Page · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Description

This project is a basic NQueens algorithm visualized utilizing the Unity Game Engine. The source project is built more as a framework for which to analyze the Static Analysis tool SonarCloud to evaluate software quality over time.

Key Features:

  • Visualized NQueens Algorithm
  • Customizable Board of N Size

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • Source Control Tool (GitKraken preferred)
  • Script Editor (VSCode preferred)
  • Windows / Mac OS

Installation

  1. Clone the repo
    git clone https://github.com/JohnMurwin/NQueensSimulation.git
  2. Initialize GitLFS and Verify
    git lfs install
  3. Initialize GitFlow using:
    Default (Master) Branch: main
    Develop Branch: dev
    Feature Prefix: feature/
    Release Prefix: release/
    Hotfix Prefix: hotfix/
    Version Tag Prefix: v

Usage

Follows standard Engine Style usage guidelines.

For examples, please refer to the F7 Style Guide: F7 Style Guide

Roadmap

See the Jira Board for a list of milestones, features, and known issues.

Branch Workflow

This project utilizes the GitFlow methodology for branch workflows. The basic workflow is as follows:

  1. Clone the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request using the PR Template.

License

Public Distribution, John Murwin 2021.
See LICENSE.md for more information.

Contact

John Murwin - @JohnMurwin - john.murwin@gmail.com

Project Website: www.project_title.com

Project Link: https://github.com/JohnMurwin/NQueensSimulation

Acknowledgements

[build-shield]: https://github.com/JohnMurwin/NQueensSimulation/actions/workflows/Builds.yml/badge.svg[build-url]: https://github.com/JohnMurwin/NQueensSimulation/actions/workflows/Builds.yml