Add README, LICENSE, and Makefile

This commit is contained in:
Timothy Warren 2019-03-29 10:35:58 -04:00
parent 996d6c68cb
commit 97da27294d
5 changed files with 71 additions and 3 deletions

2
Cargo.lock generated
View File

@ -495,7 +495,7 @@ version = "0.1.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
[[package]]
name = "media_collection_crud"
name = "media-collection-crud"
version = "0.1.0"
dependencies = [
"bodyparser 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",

View File

@ -1,8 +1,11 @@
[package]
name = "media_collection_crud"
name = "media-collection-crud"
license = "MIT"
description = "Expiremental CRUD for managing a personal collection of media"
version = "0.1.0"
authors = ["Timothy J Warren <tim@timshomepage.net>"]
edition = "2018"
publish = false
[dependencies]
bodyparser = "0.8.0"
@ -12,7 +15,6 @@ env_logger = "0.6.1"
handlebars = "1.1.0"
handlebars-iron = { version = "0.27.0", features = ["watch"] }
iron = "0.6.0"
iron-test = "0.6.0"
juniper = "0.11.1"
logger = "0.4.0"
mime = "0.2.3"
@ -22,3 +24,6 @@ serde = "1.0.89"
serde_json = "1.0.39"
staticfile = "0.5.0"
urlencoded = "0.6.0"
[dev-dependencies]
iron-test = "0.6.0"

7
LICENSE.md Normal file
View File

@ -0,0 +1,7 @@
Copyright (c) 2019, Timothy J. Warren
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

42
Makefile Normal file
View File

@ -0,0 +1,42 @@
# The default make command
DEFAULT = help
# Use 'VERBOSE=1' to echo all commands, for example 'make help VERBOSE=1'.
ifdef VERBOSE
Q :=
else
Q := @
endif
all: $(DEFAULT)
help:
$(Q)echo "make run - Runs executable"
$(Q)echo "make build - Builds main executable"
$(Q)echo "make lib - Builds library"
$(Q)echo "make test - Runs all tests"
$(Q)echo "make bench - Benchmarks library internally and externally"
$(Q)echo "make bench-internal - Benchmarks library internally"
$(Q)echo "make bench-external - Benchmarks library externally"
$(Q)echo "make doc - Builds documentation for library"
$(Q)echo "make git-ignore - Setup files to be ignored by Git"
$(Q)echo "make examples - Builds examples"
$(Q)echo "make clean - Deletes binaries and documentation.
.PHONY: build run test bench doc examples clean
build:
$(CARGO) build
run:
$(CARGO) run
clean:
$(CARGO) clean
doc:
$(CARGO) doc
test:
$(CARGO) test

14
README.md Normal file
View File

@ -0,0 +1,14 @@
# Media Collection CRUD
This is an experiment with using Rust to build a CRUD web app.
## Project Goals
* Create a practical "web app" to view / manage a collection of media, eg Movies, Video Games, Music.
* Strike a balance in Database design between a completely generic design, and a medium-specific design
* Utilize Rust as the primary implementation language
* Utilize Graphviz for design diagrams
## Non-Goals
* Single-Page App
* Full interface / Web API separation