2020-2021

README.md

@@ -1,31 +1,40 @@
 # capstone-projects
 This repo is used to organize Free Ebook Foundation projects for Stevens Institute of Technology Senior-year computer science capstone projects.
 
-## 2019-2020
+## 2020-2021
 
 Proposed project:
 
- - [Project Gutenberg in a Box](pgiab.md)
+ - [Project Gutenberg Bookshelves](bookshelves.md)
 
 
 Students interested in this project should use Github issues and pull requests to develop and propose teams. For example, students interested in a project but needing team members, and teams needing additional members should create an issue describing their interest and needs. Use issues to ask questions or seek clarification about the projects. To propose a team for a specific project, create a pull request adding the names of team members to the project page. You may also want to include roles, capabilities and the approach of the team. 
 
-Since not all projects will be pitched until September 12, I will not accept a proposal PR until the end of September 13. But please do not wait until September 13 to start a pull request even if your team is incomplete or you're still deciding - I will comment on PRs with the goal of improving them, and you can close the PR to withdraw the proposal through September 13. If there are competing proposals, I will give preference to the best developed proposal. 
+I will not accept a proposal PR until the the class has seen all the proposals. But do not wait until then to start a pull request even if your team is incomplete or you're still deciding - I will comment on PRs with the goal of improving them, and you can close the PR to withdraw the proposal. If there are competing proposals, I will give preference to the best developed proposal. 
+
+I expect to meet with teams weekly - I will use Slack for meetings and discussions. Ideally we'll be able to meet as a the team in person at least once, pandemic permitting.
+
+
+## 2019-2020
+
+Completed projects:
+
+ - [Project Gutenberg in a Box](pgiab.md)
+    - [Gutenberg Offline](https://github.com/EbookFoundation/zimgutenberg)
+ - [A search system for copyright records](copyright-renewals.md)
+    - [CCE Search Prototype](https://github.com/EbookFoundation/cce-search-prototype)
+    - [CCE Search Ansible Setup](https://github.com/EbookFoundation/cce-search-ansible)
+    - [Copyright Registrations and Renewals DB Maintenance Script](https://github.com/EbookFoundation/bardo-copyright-db)
 
-I expect to meet with teams weekly - I will use Slack for meetings and discussions. I think it's important to meet the team in person at least once, preferably multiple times over the course of a the school year.
 
 
 ## 2018-2019
 
-The complieted project was
+The completed project was
 
  - [An update pipeline for ebook authoring systems](pipeline.md)
+    - [River of Ebooks](https://github.com/EbookFoundation/river-of-ebooks)
  
-A proposed project was
-
- - [A search system for copyright records](copyright-renewals.md) 
-
-If there is a shortage of projects for 2019-2020, I am willing to consider teams interested in working on this project.
 
 ## 2017-2018
 

bookshelves.md

@@ -0,0 +1,46 @@
+# Gutenberg in a Box Project
+
+## Background
+
+Project Gutenberg is a 48 year old organization whose mission is to make public domain works available for free on the internet. To date, over 63,000 works, mostly books, have been posted. The orgaization, run mostly volunteers, _invented_ the ebook!
+
+The Free Ebook Foundation (FEF) has been helping Project Gutenberg (PG) renovate their software and platform for the past 2 years. This work partially resulted from the efforts of a Stevens Institute temam from 2017-2018.
+
+“Bookshelves” are lists of PG books that help users navigate PG. See them [here](https://www.gutenberg.org/wiki/Category:Bookshelf).
+
+
+## Problem
+
+- System for creating and updating bookshelves is failing
+    - PHP/wiki interface
+    - Loaded into production Postgres db by scraping wiki!
+    - Few people maintaining it.
+    - No way to create personal bookshelves or reading lists
+    - Recurring security issues with PHP
+
+
+## Proposed Solution
+
+- Registrationless Bookshelf Builder
+    - HTML5 local storage + javascript
+    - Button on Item page
+    - Import/export lists for sharing
+
+- Bookshelf Management App
+    - Python/Flask or Python/CherryPy with Postgres backend
+    - Managers can make new bookshelves and categories
+    - Moderators can add/remove items from Builder Bookshelves
+
+
+
+## Goal
+
+Have prototype system running by April, 2021 for public review, move to production bin May.
+
+## Team
+
+Add names and links here.
+
+## More about our team 
+
+Describe your team here.