This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
dndwebapp [2018/11/29 06:17] reisande |
dndwebapp [2020/02/28 21:11] chasty2 [Back End Documentation] |
||
---|---|---|---|
Line 6: | Line 6: | ||
==== Project Leads==== | ==== Project Leads==== | ||
^ Position ^ Name ^ Email ^ | ^ Position ^ Name ^ Email ^ | ||
- | ^ **Project Lead/Manager:** | Misha Ryabko | mryabk2@uic.edu | | + | ^ **Project Lead/Manager:** | Amy Ngo | | |
- | ^ **Front End Lead** | Josh Castor (Senior Technical Officer) | joshua.castor@joshuacastor.me | | + | ^ **Alumni Project Advisor** | Bennett Maciorowski (LUG Alumni Advisor| bennettmaciorowski@gmail.com | |
- | ^ **Back End Lead** | Brent Yurek (Senior Technical Officer) | | | + | ^ **Alumni Project Advisor** | Josh Castor (Senior Technical Officer) | joshua.castor@joshuacastor.me | |
+ | ^ **Alumni Project Advisor** | Will Toher| | | ||
==== Participants==== | ==== Participants==== | ||
Line 15: | Line 16: | ||
===== Project Structure===== | ===== Project Structure===== | ||
+ | ==== Project Requirements/UseCases ==== | ||
+ | ^ Page ^ requirements ^ Uses ^ | ||
+ | | Index/Home Page | Clean friendly design, good color balance | A landing page which'll allow people to understand what the app is and register/login | | ||
+ | | Account Creation | easy to navigate with data fields containing tooltips to aid in entering data| allows new users of the app to register accounts | | ||
+ | | Profile View | | | | ||
+ | | Character Creation | | | | ||
+ | | Character View | | | | ||
+ | | Item Creation | | | | ||
+ | | Game Creation | | | | ||
+ | | Chat Room | | | | ||
+ | |||
===== Documentation===== | ===== Documentation===== | ||
==== Front End Documentation==== | ==== Front End Documentation==== | ||
==== Back End Documentation==== | ==== Back End Documentation==== | ||
+ | __ | ||
+ | Database schema, version 2: | ||
+ | __ | ||
+ | |||
+ | **one baseStats per charSheet | ||
+ | |||
+ | {{:dnd_db_v2.jpg?nolink&400|}} | ||
+ | |||
+ | __ | ||
+ | Docker Notes: | ||
+ | __ | ||
+ | <code bash> | ||
+ | ## Enter these commands in bash on a Linux environment. | ||
+ | |||
+ | ## create docker image from dockerfile and run it. Must be in initDB directory to build lug-mysql image | ||
+ | docker build -t lug-mysql . | ||
+ | docker run -d --name=lugdb -e MYSQL_ROOT_PASSWORD=test -p 3306:3306 lug-mysql | ||
+ | |||
+ | ## delete image and instance if you need to rebuild | ||
+ | docker rm lugdb | ||
+ | docker image rm lug-mysql | ||
+ | |||
+ | ## enter mysql | ||
+ | docker exec -it lugdb mysql -uroot -p | ||
+ | </code> | ||
===== Meeting Notes===== | ===== Meeting Notes===== | ||
==== Meeting 1 [11/09/2018]==== | ==== Meeting 1 [11/09/2018]==== | ||
Line 81: | Line 118: | ||
==== Meeting 3 [11/19/2018]==== | ==== Meeting 3 [11/19/2018]==== | ||
+ | * The discussion largely centered around which software will be used to manage the database | ||
+ | * The eventual conclusion which had been reached is that we will set up a docker container, and run a NoSQL database on it | ||
+ | * The Docker Container doesn't handle interaction between databases very well, but can handle interactions between programs well, so the docker container will interact with another container which consists of a program which sets up a NoSQL database | ||
+ | * The Docker Container has a few benefits over Virtual Machines, which is what the LUG server currently uses | ||
+ | * Takes up less space/has less overhead | ||
+ | * environment can be perfectly consisten between machines, rather than having different Oses on different VMs | ||
+ | * The NoSQL database stack we will use is MongoDB | ||
+ | * Kartikeya Tripathi will set up the Docker Container and database with Bharat Middha | ||
+ | * The first goal for the Docker container is to have a skeleton which just runs flask and the NoSQL database | ||
+ | * The API is going to be in the RESTful style | ||
+ | * This just means that JSON objects will be sent over HTTP | ||
+ | * The JSON objects will contain the information to render the character output page | ||
+ | * More images which visualize the server client dynamic have been posted by Jacob Raffe on the Slack | ||
+ | |||
+ | * Also, Ben Maciorowski created a logo out of Tux wearing a wizard hat, this image is located on slack | ||
+ | |||
+ | * Back end Skeleton has been finished, can navigate between pages | ||
+ | * only three pages needed are the Character input, Character Output, and Home pages | ||
+ | |||
+ | * The next goal for Back end is to make API specifications, as Front End development largely depends on the JSON objects sent by Back end | ||
+ | * Brent Yurik will give notes on, and lead the discussion regarding the API specification | ||
+ | * The next meeting will be on Friday November 30th | ||
+ | ==== Meeting 4 [11/30/2018]==== |