A LastWill API - our web and mobile Project for the class Service Security
The LastWill API allow users to create and store their legal will, pictures, stories, memo, notes, memories..etc, which can be shared to their love ones after they pass. The app can be useful for eldery citizens, caretakers, patients with terminal stage dieseases, military full-time service personel, anyone in a higher risk roles/jobs etc. This project will focus on high data privacy and security and also intelligent sharing and distribution functionality.
It includes the following features:
- create/edit user/patient decease confirmation/validation and control rules.
- add/edit inheritor(s) or legal representative(s) notification and reminder.
- add/edit/delete documents (types: Will, Photos, Memo, stories, notes..etc)
- use recent and reliable hashing, encryption and decryption algorithms
- have both Web and mobile UI
- etc..
Required development enviroment:
- Language Ruby 2.6.2
- Roda framework -v 3.18
Other Required packages:
- Rack
- libsodium32 -rbnacl
- see gem file for full detail
All routes return Json
- GET
/: Root route shows if Web API is running - GET
api/v1/notes/[proj_id]/inheritor/[doc_id]: Get a document - GET
api/v1/notes/[proj_id]/inheritors: Get list of documents for project - POST
api/v1/notes/[ID]/inheritors: Upload document for a project - GET
api/v1/notes/[ID]: Get information about a project - GET
api/v1/notes: Get list of all projects - POST
api/v1/notes: Create new project
-Install this API by cloning the relevant branch and installing required gems from Gemfile.lock:
Run this API using:
bundle installSetup development database once:
rake db:migrateRun this API using:
rackupSetup test database once:
RACK_ENV=test rake db:migrateRun the test specification script in Rakefile:
rake specBefore submitting pull requests, please check if specs, style, and dependency audits pass:
rake release?
Reference: base on soumyaray ISS secuity repo @ https://github.com/ISS-Security/credence-api/tree/0_api_mvc