USF Projects

Partnership with the University of San Francisco

Hello everyone!

I look forward to our first meeting. I've invited all of you into my Slack group so we can communicate more effectively. Please make sure to add a profile image and your name to your Slack profile.

I'm going to need your GitHub usernames as well so I can invite you to the project. So when you get a chance, send me all of your GitHub usernames via Slack.

We are going to start the first 2 weeks of the semester building a test project so that everyone has experience with backend and frontend development. The test project is explained below.

Before that I want everyone to get a basic understanding of Javascript just in case some of you have never used it or need a quick reminder.

Here are some javascript tutorials I want you to read starting with the Mozilla link. It goes over the basics of Javascript, please spend at least 2 hours reading it. At the very minimum, I want you to read the section titled "Intermediate: A re-introduction to JavaScript" but feel free to start from the first section "Complete Beginners" if you've never had any Javascript experience. I provided other tutorials for you to review just in case you wanted more experience with Javascript.

GitHub Tutorial: Understanding the basics of GitHub
Read this if you don't have experience with Github

https://guides.github.com/activities/hello-world/

GitHub Student Education Resources

https://github.com/education/students#offers

API tutorials: What is an API??
Read this if you don't know what an API is

Best Javascript Editor

Visual Studio Code: https://code.visualstudio.com/

API Test project
As described previously here is the Todo test project I want everyone to work on. The goal is to get experience building an API the first week and then learn how to build the frontend next week. In the third week, we will start the real project using this test project as the base of the project. I’m hoping the backend can be completed by our next meeting and the frontend by the following meeting. I know this is a lot for first time students but this will give me a clear understanding of everyone’s capabilities. These deadlines can always be extended.

Build an API with the following features and then upload a video showing all the functionality in our team Channel. This is an individual project but you’re more than welcome to reach out to each other for help

Node.js API (First Week)
1. POST: Create a TodoList
2. GET: Get all of the TodoLists
3. POST: Create a TodoItem for a specific list
4. GET: Get all the TodoItem's in the TodoList
5. PUT: Update a TodoItem and mark it as done
6. DELETE: Delete a TodoListItem
7. DELETE: Delete a TodoList
Useful tools
1. Postman to make local API requests
  1. https://www.postman.com/
Use the following Node.js packages
1. Express
2. Optional
  1. Nodemon
  2. Sequelize
    1. I found this useful when starting out but others have not. So let me know how it goes for you
Database
1. PostgresSQL
  1. You will need to find a client that works with your machine
Second Week - Front End (Web or Mobile TBD) App
1. This app should call all of the APIs you created previously
2. The UI is not that important for this part but you’re encouraged to improve the UI if you finish the tasks above
Advanced Assignment [Don’t start this unless you finish the assignment above]
1. Add sign up/login for users
  1. Allow users to manage their own TodoLists and TodoListItems
  2. Use JWT (Json Web Tokens) to handle user authentication. You may need an additional encryption npm
2. Feel free to add anything else!

The goal of this Todo project is for everyone to get experience with the backend and frontend so you can understand what part of the tech stack you want to focus on for the real project. You can do both if you have the time or just focus on one based on your goals.

I’m going to work on writing up a more detailed description of the real project with a breakdown of the features we want to build over the next couple of days so you can include them in your Statement of Work (SOW). These can also be found under the semesters project page.

Let me know if you have any questions! I’ll send another update next week to remind you to upload a working video of your API and to let you know that you can now start working on the frontend side of the Todo project.

I look forward to working with all of you this semester!

Thanks for reading,

Jose Alvarado

Here's an example of a database/table schema for a todo list application that supports multiple lists per user:
USERS Table

id (primary key)
username
password_hash
email

TODO_LISTS Table

id (primary key)
user_id (foreign key referencing USERS.id)
title

TODO_ITEMS Table

id (primary key)
todo_list_id (foreign key referencing TODO_LISTS.id)
content
due_date
is_completed

In this schema, each user has their own unique ID, and they can create multiple todo lists. Each todo list has a unique ID and belongs to a specific user, and each todo item belongs to a specific todo list. The TODO_ITEMS table includes a content field for the actual text of the todo item, a due_date field for setting a deadline, and an is_completed field to indicate whether the item has been completed.

Example of Class Schedule

As part of the project spec or SOW you will be required to submit a class schedule. Below is an example from a previous class to use as a references. I want you to write up your own class schedule based on 3 or 4 core features that need to get done by the end of the semester and then sprinkle in any other features along the way. These 4 core features will be broken up into 2 week sprints as shown below.

2022 Decentralized Storage Project
Class Schedule

9/19
1. TodoList Project - Node.js Assignment: Create an API that can do the following requests
  1. POST: Create a TodoList
  2. GET: Get al of the TodoLists
  3. POST: Create a TodoItem for a specific list
  4. GET: Get all the TodoItem's in the TodoList
  5. PUT: Update a TodoItem and mark it as done
  6. DELETE: Delete a TodoListItem
  7. DELETE: Delete a TodoList
9/26
1. TodoList Project - Frontend Assignment: Create a frontend that connects to your API
  1. Create the UI for the TodoList project you made last week
10/10 Sprint 1 - Sign up and Login
1. Create Accounts
  1. Sign up and log in
  2. Email and password required
2. Dashboard
  1. Edit profile
    1. First and last name
  2. Users can apply to become a host by submitting their bank credentials
  3. Log out
  4. Reset password and update email address
10/24 Sprint 2 - Crete listings
1. Approved hosts can see an additional tab where they can create and view their listings
2. Hosts can create listings
  1. Select type of storage
  2. Enter price per month or per day, location, description
  3. Upload pictures
3. Hosts can view and edit all of their listings
10/28 Midterm Presentation
11/7 Sprint 3 - Search listings + Message hosts
1. Dashboard
  1. Users can view and search listings
    1. Filter by location and price
    2. Maybe add a map
  2. Users can tap on the listing to see the details
2. Users can message the hosts
11/21 Sprint 4 - Complete transactions + View Reservation History + Rating System
1. Users can complete a transaction using Stripe
  1. Users should send a message to hosts to go over the details of arriving
  2. We take 10% of the transaction
2. Users and hosts can see a history of all of their transactions
3. Users and hosts will be able to rate each other
  1. That rating will be visible when viewing the listing
4. Hosts can get their funds deposited immediately
12/9 Final Deliverables Due
1. Final Paper
  1. If papers are not required, then a reference document outlining a summary of the app
2. A detailed README file outlining how to run and make changes to the app
3. Fix remaining bugs + improve the UI
12/12 Class Ends

Make sure to review it with each other and let me know if you have any questions!

Partnership with the University of San Francisco

Example of Class Schedule

Home

Contact Us