pull/11/head
eric 2021-09-02 10:37:49 -04:00
parent a7709644a1
commit ae4815b651
2 changed files with 58 additions and 4 deletions

View File

@ -1,20 +1,25 @@
# capstone-projects
This repo is used to organize Free Ebook Foundation projects for Stevens Institute of Technology Senior-year computer science capstone projects.
## 2020-2021
## 2021-2022
Proposed project:
- [Project Gutenberg Bookshelves](bookshelves.md)
- [Free-Programming-Books](fpb.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.
I will not accept a proposal PR until September 10. 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 am happy to schedule a Q&A session via Zoom- just request one via Github issues.
I will not accept a proposal PR until September xx. 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 am happy to schedule a Q&A session via Zoom- just request one via Github issues.
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.
I expect to meet with teams weekly - I will use Slack for meetings and discussions. Ideally we'll be able to meet as a team in person, Covid permitting.
## 2020-2021
- [Project Gutenberg Bookshelves](bookshelves.md)
## 2019-2020
Completed projects:

49
fpb.md Normal file
View File

@ -0,0 +1,49 @@
# Free-Programming-Books Project
## Background
[Free Programming Books](https://github.com/EbookFoundation/free-programming-books) is a list of over 3,000 free programming books and other free programming resources, maintained collaboratively as a repository on Github. With lists in 37 spoken languages, it has helped countless programmers around the world acquire and improve their programming abilities.
Free Programming Books is a product of Open-Source culture, and continues to be a stunning example of what con be created when large numbers of people work together.
It was originally a clone of a StackOverflow page that was moved to GitHub by Victor Felder for collaborative updating and maintenance. After going viral on Hacker News, it grew rapidly and is now one of the most popular repositories on Github, with over 200,000 "stars", over 6100 commits, over 1600 contributors, and over 43,000 "forks". In 2017, the Free Ebook Foundation assumed responsibility for the administration and care of the repository.
### How it Works
Git is an open-source collaboration and version-control system written by Linus Torvalds. Github is a website used by programmers to structure the workflow and collaboration around the software they develop. A developer wishing to contribute an improvement to a software project first "forks" the repository containing the software, then modifies the code to implement the new feature or bugfix. When they're satisfied with their changes and have tested it for functionality, they create a "pull request" asking that changes be pulled into the main branch of the projects code. If the owner of the repository likes the change, the pull request is merged.
Free Programming Books applies Github's workflow to the creation and maintenance of a list of books. The cycle of fork, modify, pull request and merge has happened over 4,000 times, resulting in the list's grand scope and comprehensiveness.
## Issues
- Its just a bunch of markdown lists, minimally structured.
- Cant search it.
- Cant export and reuse it.
- How to archive all the books?
## Proposed Project
1. Parse the lists into a structured database
- Github Actions, Continuous Integration Python?
2. Load the database into a website
- Django? Postgres? AWS?
3. Export a data file.
- CSV? XML? OPDS?
4. Download and store the books somewhere.
- Internet Archive?
## Goals
- Build parser running as a GitHub action by end of 2021
- Do something fun with it by April 2022
## Team
Add names and links here.
## More about our team
Describe your team here.