Skip to content

Commit

Permalink
README and proof utils
Browse files Browse the repository at this point in the history
Updated readme and has some proof util changes
  • Loading branch information
Jack-Rutland committed Aug 27, 2022
1 parent 72dc02b commit af7e9fd
Show file tree
Hide file tree
Showing 6 changed files with 558 additions and 233 deletions.
165 changes: 92 additions & 73 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,92 @@
# Getting Started with Create React App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)


# existential-graphs
<div align="center">
<img src="https://i.ibb.co/JQspFJZ/eg-banner.jpg">
<br />
<br />
<a href="https://choosealicense.com/licenses/gpl-3.0/"><img src="https://img.shields.io/badge/license-GPL%203.0-red" alt="GPL 3.0 License"></a>
<br />
<i>A tool for diagrammatic notation of logical expressions</i>
</div>
<hr />

Existential Graphs is a web app that enables the manipulation of logical expressions using a visual notation. It was created by [Dr. Bram van Heuveln](https://science.rpi.edu/itws/faculty/bram-van-heuveln), whose goal for this project is to provide another unique approach to solving logical expressions to students.

<br />

## If you would like to access Existential Graphs, the live website can be found [here](https://eg.bram-hub.com/).
> Note: Existential Graphs is currently under development. As such the live website will not always be in sync with what is here in the repository. Currently, the live website is on a functionally complete version, however a rehaul of the website should end up going live in the near future.
## Table of Contents
- [If you would like to access Existential Graphs, the live website can be found here.](#if-you-would-like-to-access-existential-graphs-the--live-website-can-be-found-here)
- [Table of Contents](#table-of-contents)
- [Background](#background)
- [Use Cases](#use-cases)
- [Guided Proof Mode](#guided-proof-mode)
- [Unguided Proof Mode](#unguided-proof-mode)
- [For Educators](#for-educators)
- [For Students](#for-students)
- [Development](#development)
- [License](#license)

## Background
Dr. van Heuveln has taught logic courses on a frequent basis for the past 15 years, and noted that a good number of students struggle with the systems of modern formal logic that were developed in the late 1800's and early 1900's, and that have been universally used in logic courses since. These traditional systems use abstract linear symbol strings such as `(P & Q) -> (R v S)`, and deploy even more abstract rules such as & Elim to infer new symbol strings from old ones, thus engaging the user in logical reasoning.

This project brings about the idea that there are unique ways to view logical expressions, as well as teach students about logic.

The idea at the core of Existential Graphs, graphical logic, was first written about in 1882 by Charles Sanders Peirce. While it is interesting and in many cases helpful to analyze logical expressions with a graphical system, it is largely infeasible due to physical constraints. The only way to use existential graphs so far has been on paper or a whiteboard, where you are limited by space, and have to redraw the whole logical expression every step, or lose your previous steps. The Existential Graphs web application is one of the first, if not the first, publicly available systems to use graphical logic.

## Use Cases
The Existential Graphs web application can be used by philosophers, educators, and students alike. The experience can be very beginner friendly in the guided mode, or act more as a sandbox in the unguided proof mode.



### Guided Proof Mode
Guided Proof Mode is intended mainly for beginners to existential graphs. In this mode, you are given a pallet of operations that are available in existential graphs which you are allowed to use to manipulate the graph. You are not allowed to make incorrect proof steps, which makes this a safe space to learn the basics of existential graphs.

### Unguided Proof Mode
Unguided Proof Mode is the main mode intended for Existential Graphs. In this mode, you can directly operate on the graph and define what proof step you took. This allows for users to make logically invalid steps, which is great for students who are beyond a beginner level. This mode also has proof validation, which will tell you which steps you took were logically valid, as well as the steps that you took that were logically invalid.

## For Educators
As an educator, you are able to create a "Problem". A problem is simply a graph with an initial state and a goal state. With this problem, you are able to send it to your students and have them solve it. Their goal is to get from the initial state to the goal state, using only valid logical operations. Existential Graphs can check the validity of these steps, making grading easy for educators.

## For Students
As a student, you are able to upload problem files that you have received from your professor. When you open the problem file, you will see an initial state and a goal state. Your objective is to take the initial state graph, and manipulate it using logical steps until you reach the goal state. As you work with the graph, your steps will create branches, so don't worry about losing your progress if you want to explore a different route.

Additionally, if you are interested in computer science and programming, please consider contributing to Existential Graphs! Not only would it be a great way to practice logical reasoning, but it is also a great way to dip your toes into open source software and contributing to open source projects.

## Development
To work on and run this project, you will need to have Node.js installed.

You will have to run two terminals :

In the first terminal :
```
cd server
npm i
npm run start
```
In the second terminal :
```
cd client
npm i
npm run start
```
Now everything should be up and running for you to work on Existential Graphs!
## License
Existential Graphs is licensed under the GPL-3.0 license, which can be viewed [here](LICENSE).
```
Existential Graphs: A Unique Approach to Formal Logic
Copyright (C) 2022, the Existential Graphs Developers
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```
2 changes: 1 addition & 1 deletion client/src/components/Paper/scripts/Atomic.js
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ export default class Atomic extends joint.dia.Element {

destroy() {
this.remove();
this.sheet.paper.handleDeleteCell();
//this.sheet.paper.handleDeleteCell();
}

obliterate() {
Expand Down
2 changes: 1 addition & 1 deletion client/src/components/Paper/scripts/Cut.js
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ export default class Cut extends joint.dia.Element {
this.sheet.handleCollisions(parent);
}

this.sheet.paper.handleDeleteCell();
//this.sheet.paper.handleDeleteCell();
}
//Destroys itself and all decendants
obliterate() {
Expand Down
3 changes: 2 additions & 1 deletion client/src/components/Paper/scripts/Sheet.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ export default class Sheet {
// the diagram (parent / child structure (embedding)) to reflect what the user
// sees on the paper
let cellbbox = cell.getBoundingBox();


console.log(this);
let potential_parents = this.findPotentialParents(cellbbox);
let parent = findSmallestCell(potential_parents);

Expand Down
Loading

0 comments on commit af7e9fd

Please sign in to comment.