51 lines
2.5 KiB
Markdown
51 lines
2.5 KiB
Markdown
__BearShop__
|
|
=============
|
|
|
|
> John Hammond | August 17th, 2016
|
|
|
|
------------------------------
|
|
|
|
This repo is dedicated to housing all materials and code for an idea that I have titled "BearShop." My classmates have came to me with an idea to create a buy/trade/sell store for the USCGA, so this is all the work put in for my rendition of it.
|
|
|
|
I plan to do this project in [Python] with [Flask].
|
|
|
|
File & Directory Information
|
|
----------------
|
|
|
|
* [`ctf_skeleton/`](ctf_skeleton/)
|
|
|
|
This directory holds some code from a recent CTF platform I tried to build on my own. I am using elements from it, so I just snagged to code to be able to cherry-pick off of it and change what I need to get this project rolling. __Do not consider it a part of this project; it is _not_. It is just included as a convenience for me while the BearShop project is still be developed.__
|
|
|
|
* [`static/`](static/)
|
|
|
|
This folder is required by [Flask] and it is where all "static" files live, like things for [CSS] or images or fonts.
|
|
|
|
* [`templates/`](templates/)
|
|
|
|
This is another folder required by [Flask], and it stores all of the [HTML] code that builds the markup of the website.
|
|
|
|
* [`schema.sql`](schema.sql)
|
|
|
|
This is the [SQL] schema file that is used to create the database for the webpage. It should create and define tables for things like users, the products on sale, and anything else that may be deemed necessary.
|
|
|
|
* [`setup.sh`](setup.sh)
|
|
|
|
This is the [`bash`][bash] script that I planned on using to initially create the server. It sets up the database, creates private keys to be used, and modifies a "base" rendition of the server [Python] script to add all of the configuration variables that can be set _in the_ [`setup.sh`](setup.sh) script.
|
|
|
|
|
|
* [`server_base.py`](server_base.py)
|
|
|
|
This is actual source code of the web application. __! Remember, it is _not_ what you will actually run to deploy the server; the [`setup.sh`](setup.sh) script will take it and configure it, to create a new, functional `server.py` which is what you will run when you deploy.__
|
|
|
|
* [`clean.sh`](clean.sh)
|
|
|
|
This is just a one-liner script that just gets rid of the created `server.py` and the private keys created for use with [HTTPS].
|
|
|
|
|
|
[Python]: https://www.python.org/
|
|
[Flask]: http://flask.pocoo.org/
|
|
[SQL]: https://en.wikipedia.org/wiki/SQL
|
|
[bash]: https://en.wikipedia.org/wiki/Bash_(Unix_shell)
|
|
[CSS]: https://www.w3.org/Style/CSS/Overview.en.html
|
|
[HTML]: https://en.wikipedia.org/wiki/HTML
|
|
[HTTPS:]: https://en.wikipedia.org/wiki/HTTPS |