diff --git a/FlashCards-master/AUTHORS b/FlashCards-master/AUTHORS new file mode 100644 index 0000000..288e4d2 --- /dev/null +++ b/FlashCards-master/AUTHORS @@ -0,0 +1,6 @@ +The following individuals are the contributors for FlashCards: + +Conner Brigman +Dustin Layne +Daniel Nedrow +Sabrina Pyatt diff --git a/FlashCards-master/CONTRIBUTING.md b/FlashCards-master/CONTRIBUTING.md new file mode 100644 index 0000000..d23baa8 --- /dev/null +++ b/FlashCards-master/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# **Getting Started:** + +- Review [TOOLCHAIN.md](https://github.com/d-nedrow/FlashCards/blob/master/TOOLCHAIN.md) and install the needed tools for development. +- Join the RaiderPlanner slack team and join the spring2019group1 channel +- Fork the FlashCards repository [here](https://github.com/d-nedrow/FlashCards) +- Clone your fork of the FlashCards repository + +# **Workflow** + +- Make sure to keep your fork synced [(info on how to keep your fork synced)](https://help.github.com/en/articles/fork-a-repo#keep-your-fork-synced) +- Select and "claim" an issue so to keep a smooth workflow and prevent conflicts +- Create a new branch (and name your branch something that relates to the issue your working on) to perform your work on and make your commits +- When ready, push your branch up to your repository then create a pull request to merge it into the master repository + +## **GUI** + +- When working on GUI code, make sure to include screenshots/video samples of what your changes fix/do. +- Follow the [GUI guidelines](https://github.com/rsanchez-wsu/RaiderPlanner/wiki/Modifying-the-GUI) diff --git a/FlashCards-master/DesignDocuments/FlashCardsFlow.html b/FlashCards-master/DesignDocuments/FlashCardsFlow.html new file mode 100644 index 0000000..adf9fc9 --- /dev/null +++ b/FlashCards-master/DesignDocuments/FlashCardsFlow.html @@ -0,0 +1,12 @@ + + + +Draw.io Diagram + + + + +
+ + + diff --git a/FlashCards-master/DesignDocuments/FlashCardsFlow.pdf b/FlashCards-master/DesignDocuments/FlashCardsFlow.pdf new file mode 100644 index 0000000..c2d4f16 Binary files /dev/null and b/FlashCards-master/DesignDocuments/FlashCardsFlow.pdf differ diff --git a/FlashCards-master/README.md b/FlashCards-master/README.md new file mode 100644 index 0000000..f9a7f18 --- /dev/null +++ b/FlashCards-master/README.md @@ -0,0 +1,10 @@ +# FlashCards + +#### Building and Running the Project + +There are 2 easy ways to build and run the project. + +1. Use the NetBeans IDE, which can be downloaded from https://netbeans.org/downloads/8.2/. From within NetBeans, click "Open Project" and choose the FlashCards folder downloaded from GitHub. The folder already contains what you need for a NetBeans project. You can make changes to the code (if desired) and click the "Run Project" button, and the project will be built automatically before running. +2. If you don't want to use the NetBeans IDE, then you can edit the source files however you choose. You will need to use Ant to build the project before running it. Download Ant from https://ant.apache.org/bindownload.cgi. Here is an easy set of instructions on how to setup Ant on Windows: https://www.mkyong.com/ant/how-to-install-apache-ant-on-windows/. Once you have Ant set up, you can build and run the project as follows: + - On the command line, navigate to the FlashCards directory (the folder you downloaded from GitHub), and type: "ant". This will build the project. + - From the FlashCards directory, type "cd build/classes" to navigate to the classes directory. Then type "java flashcards.Main" to execute the program. \ No newline at end of file diff --git a/FlashCards-master/TOOLCHAIN.md b/FlashCards-master/TOOLCHAIN.md new file mode 100644 index 0000000..c43a801 --- /dev/null +++ b/FlashCards-master/TOOLCHAIN.md @@ -0,0 +1,35 @@ +# **FlashCards Development Toolchain** + +This document summarizes the necessary toolchain for developers contributing to the FlashCards project. + +The basic tools include: a JDK, NetBeans 8.2 IDE (or any IDE/environment as long as Apache Ant is installed), and the Git version control software. + +# **JDK** + +Make sure you have a JDK by running the command `javac -version`. If there is an error, you either need to download an installer package [here](https://www.oracle.com/technetwork/java/javase/downloads/index.html), or possibly set your PATH. + +# **NETBEANS** + +Download NetBeans 8.2 [here](https://netbeans.org/downloads/8.2/) or [here](https://netbeans.org/community/releases/82/index.html) + +# **GIT** + +If using Linux, Git will probably already be installed. + +If using Windows, download an installer package [here](https://git-scm.com/download/win) + +If using Mac, download an installer package [here](https://git-scm.com/download/mac) + +After installing Git, run the command `git --version` to get the version and make sure it's installed on your machine + +You can find more info on setting up Git [here](https://help.github.com/en/categories/setup) + +You can find info on using Git [here](https://git-scm.com/book/en/v2) + +# **APACHE ANT** + +If you are not using the NetBeans IDE, you need to make sure to install Ant so you can build your java files. + +You can install Ant [here](https://ant.apache.org/bindownload.cgi) + +You can find info on setting up/installing Ant [here](https://www.mkyong.com/ant/how-to-install-apache-ant-on-windows/) diff --git a/FlashCards-master/build.xml b/FlashCards-master/build.xml new file mode 100644 index 0000000..e9d8d86 --- /dev/null +++ b/FlashCards-master/build.xml @@ -0,0 +1,53 @@ + + Builds, tests, and runs the project FlashCards. + + + diff --git a/FlashCards-master/build/built-jar.properties b/FlashCards-master/build/built-jar.properties new file mode 100644 index 0000000..2705fd3 --- /dev/null +++ b/FlashCards-master/build/built-jar.properties @@ -0,0 +1,4 @@ +#Sun, 06 Oct 2019 22:11:47 -0400 + + +/Users/dylan/Desktop/FlashCards-master= diff --git a/FlashCards-master/build/classes/flashcards/LoginWindow.fxml b/FlashCards-master/build/classes/flashcards/LoginWindow.fxml new file mode 100644 index 0000000..05935c3 --- /dev/null +++ b/FlashCards-master/build/classes/flashcards/LoginWindow.fxml @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + +