|
| 1 | +# Project 1, Part 1 |
| 2 | + |
| 3 | +* Assigned: 1/28 |
| 4 | +* Due: Meetings by 2/18, final version on Gradescope on 2/25 @ 10 AM |
| 5 | +* 25% of overall Project 1 grade |
| 6 | + |
| 7 | +In Part 1, you will propose a web application to build for the rest of Project 1. You will design the entity-relationship diagram and schema of the database, and do some setup for Part 2. |
| 8 | + |
| 9 | +These directions are long, but please read them carefully before you start. |
| 10 | + |
| 11 | +**Note**: If you observe holidays that overlap with this part of the project, please email the instructor to arrange for alternative deadlines within 2 days of the release date. |
| 12 | + |
| 13 | +* [FAQs](#frequently-asked-questions) |
| 14 | +* [Project overview: Read this carefully before starting](./README.md) |
| 15 | +* [Staff Approval Meeting Signup](https://calendar.google.com/calendar/u/0/selfsched?sstoken=UUpOU05mUUpZYXk2fGRlZmF1bHR8YmE0YmE0M2MzNzkyYWZjOTcxYjRkMTBmNDNmNjA1NDc): Meet as a team to discuss the project with an IA or Professor Wu. We want to make sure the scope is appropriate. You should complete Step 1 before the meeting. |
| 16 | + * We will post zoom links for each staff member to use. |
| 17 | +<!--* CVN students still need to meet us for project 1 part 1, the local teammate can represent both of you. For teams that both students are remote, we will use Skype to meet. If you have a large time difference (e.g., singapore) then arrange so that the staff member knows.--> |
| 18 | + |
| 19 | + |
| 20 | +# Overview |
| 21 | + |
| 22 | +This assignment consists of multiple steps. At a high level, you will |
| 23 | + |
| 24 | +1. Find teammate |
| 25 | +1. Select an application, write a short proposal and construct the Entity-relationship diagram. |
| 26 | +1. Meet with staff for approval and feedback |
| 27 | +1. Revise proposal and E/R diagram, create SQL schema for the database. |
| 28 | + |
| 29 | +If you're having trouble thinking of an application, look for a real dataset to design the application around. Some possible suggestions could be local government datasets like [NYC Open Data](https://opendata.cityofnewyork.us/), [Columbia Libraries catalog](https://library.columbia.edu/bts/clio-data.html), [Bio datasets](https://github.com/OpenGene/awesome-bio-datasets), [Political datasets](https://fivethirtyeight.com/features/why-were-sharing-3-million-russian-troll-tweets/), [Earthquake datasets](https://earthquake.usgs.gov/data/data.php), etc. There are many small shops, galleries, communities, that could benefit from a web applications too! |
| 30 | + |
| 31 | + |
| 32 | +### You Will Submit: |
| 33 | + |
| 34 | +You will upload your final proposal as a PDF to Gradescope. |
| 35 | + |
| 36 | +**Required** Application Proposal |
| 37 | + |
| 38 | +* Describe the general "domain" of your application, construct an Entity-Relationship |
| 39 | + diagram, **and map it to a relational schema using the mapping technique |
| 40 | + that we will cover in class.** |
| 41 | +* Pick an application with a schema that is relatively substantial, but not too large. |
| 42 | + * E/R design should have ~5-10 entity sets and a ~5-10 relationship sets. |
| 43 | + You will get a sense if your design is too simple or too complex as diagram it. |
| 44 | + Discuss this with a TA during your advising session if you are in doubt. |
| 45 | + * Please use the ER diagram notations described in class. Do not use other notations you find -- there are too many and it will be impossible to assess! |
| 46 | + * Try to make your application interesting, including a variety of different kinds of attribute |
| 47 | + domains (e.g., strings, integers, etc.) and relationships with different key and |
| 48 | + participation constraints. |
| 49 | +* Include as many relevant constraints for your application from the |
| 50 | + real world as possible in your E/R diagram. |
| 51 | + |
| 52 | +<a name="contingency"></a> **Optional but strongly recommended: Contingency plan for two-person teams**: |
| 53 | + Since students may drop classes, and to prevent last-minute surprises, we suggest that you |
| 54 | + write a "contingency plan" in case a team-mate drops the class later in the semester. |
| 55 | + |
| 56 | +* Indicate how you will simplify the project for a single person to complete. |
| 57 | +* Revised ER design with roughly 3-7 entity sets and 3-7 relationship sets. |
| 58 | +* If your teammate drops the class, you will complete the contingency version instead of finding a new teammate. |
| 59 | + |
| 60 | +**If you choose not to submit this plan when you submit Part 1 and your team-mate drops the class later, you will have to complete the original project. No exceptions will be made at that point.** |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | +## Step 1: Prepare for meeting with course staff |
| 65 | + |
| 66 | +1. Find a team-mate and indicate them when submitting Part 1. |
| 67 | +1. Write an informal one-paragraph description of the application (less than 20 lines). Highlight interesting and challenging parts. The more concrete your written description, the more efficient and useful the meeting with the class staff will be. This paragraph should include: |
| 68 | + * A high-level description of the general domain of the application. |
| 69 | + * Examples of entities and relationship sets, attributes and real-world constraints you will have. |
| 70 | + * What data you will use to populate your database, you can use real data or make up your own. |
| 71 | + * Provide details about how users will interact with the site, please describe the general "entities" that are involved, and what types of operations users can perform. For example, if your website is based on the Internet Movie Database, the user might find actors of a moview, read review, add it to watchlist and find similar movies, etc. |
| 72 | +1. Write a short description of your contingency plan (see above). |
| 73 | +1. Construct the E/R diagram for the application. You will go over it with the staff during the meeting. |
| 74 | + |
| 75 | + |
| 76 | +## Step 2: Revise and complete Part 1 |
| 77 | + |
| 78 | +1. Meet with a TA or the instructor to ensure the design is appropriate and get feedback: |
| 79 | + * This 10-15 minute meeting is required. |
| 80 | + * We will have expanded office hours during that week. |
| 81 | + * At least one must attend. It's much better if both attend. |
| 82 | + * **At least 24 hours before your meeting**, submit a draft version of your materials on Gradescope (ungraded). |
| 83 | + * **It is a good idea to come earlier in the week.** If you choose to come later and it is too crowded, then you will be unhappy. |
| 84 | +1. After the meeting, modify the description and E/R diagram based on the feedback. |
| 85 | +1. Map your E/R diagram into a relational schema in SQL, preserving the constraints. |
| 86 | +1. Submit a digital copy of the following on the due date: |
| 87 | + 1. Revised one-paragraph description of the application |
| 88 | + 2. Revised Entity-relationship diagram |
| 89 | + 3. **Resulting SQL schema** |
| 90 | + 4. Revised contingency plan (optional) |
| 91 | +1. Keep a copy of all these materials for yourselves, since you will need them for Parts 2 and 3 |
| 92 | + |
| 93 | + |
| 94 | +# Grading |
| 95 | + |
| 96 | +Your grade will be split as follows: |
| 97 | + |
| 98 | +* (7pts) Meeting with class staff: If you come to the meeting prepared with your written description and E/R diagram, you can expect to get all points, even if you are asked to make changes or revisions to your proposal. |
| 99 | +* (6pts) Quality of final one-paragraph description of your application: We will evaluate the overall quality of your final one-paragraph description of your application, including how thoroughly you incorporated any revisions suggested during your meeting with the staff. |
| 100 | +* (6pts) Quality of E/R diagram: We will evaluate how well your E/R diagram models your proposed application, including how well you modeled any relevant real-world constraints. |
| 101 | +* (6pts) Quality of your SQL schema: We will evaluate how well you mapped your E/R diagram, including constraints, into a SQL schema using the technique that we covered in class. |
| 102 | + |
| 103 | +If the submission is difficult to read and the staff cannot easily decipher what is drawn/written, then |
| 104 | +you will not recieve points for that part. |
| 105 | + |
| 106 | + |
| 107 | +# Frequently-Asked Questions |
| 108 | +<a name="faq"></a> |
| 109 | + |
| 110 | +* I have an idea that requires that I work alone. Can I? |
| 111 | + * No, sorry. Please modify your project idea so that it becomes appropriate for a two-person team. Yes, being forced to work with others is sometimes painful, but I believe that some of the most valuable lessons you learn in University are not the course content. |
| 112 | + |
| 113 | +* Can we have a team of 3, 4, or 12 students? |
| 114 | + * No, sorry. For fairness and to make it possible for us to grade them, the projects need to have similar size and scope. |
| 115 | + |
| 116 | +<!-- |
| 117 | +* Can I use my favorite DBMS instead of PostgreSQL? |
| 118 | + * No, sorry. We would like to be more flexible but don't have the staff to handle several diverse systems and platforms. |
| 119 | +--> |
| 120 | + |
| 121 | +* Can I use Java (or something that's not Python) for Option 3? |
| 122 | + * No, sorry. Please see the answer to the previous question. |
| 123 | + |
| 124 | +<!--* I'm a CVN student, is the IA meeting mandotory? |
| 125 | + * Yes, you still need to meet us for project 1 part 1. The local teammate can represent both of you, if both students are remote, we will use Skype to meet. --> |
0 commit comments