diff --git a/printFLWarrior.png b/printFLWarrior.png new file mode 100644 index 0000000..1e23e5a Binary files /dev/null and b/printFLWarrior.png differ diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..43bea7d --- /dev/null +++ b/readme.md @@ -0,0 +1,20 @@ + +# FLWarrior +#### Formal Languages Class Project + +This project has is divided between **back-end** and **front-end**. + +The back-end is under the `lib/` folder and is used by the front-end to implement the logic of Grammars, RegularExpressions, and Machines. Each of these, in the front-end, have their own `index.tsx` and edit `pages.tsx`. The front-end is located in the `pages/` folder. + +We also use the browser-integrated database to store information about the languages, which makes this project esclusively client-sided. This is located in the `database/` folder. + +## Running + +You will need NodeJS v14.x or higher +``` +npm install # Installs dependences +npm run start # runs +``` + +### Interface capture: +