Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cathyfu1215/huskyjobhunttracker
Our final project for Mobile Development class, team with Serena. A job hunt tracker with journal entries, todo lists and achievement system..
https://github.com/cathyfu1215/huskyjobhunttracker
Last synced: 6 days ago
JSON representation
Our final project for Mobile Development class, team with Serena. A job hunt tracker with journal entries, todo lists and achievement system..
- Host: GitHub
- URL: https://github.com/cathyfu1215/huskyjobhunttracker
- Owner: cathyfu1215
- Created: 2024-07-20T19:36:53.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-22T17:59:21.000Z (5 months ago)
- Last Synced: 2024-11-11T21:13:21.473Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 9.37 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Project Name: HuskyJobHuntTracker
#### CS5520 2024 Summer , Group 2
#### Team members: Cong (Cathy) Fu , Jieling (Serena) Gong
----
## Video Demo of our final product:
https://vimeo.com/1001691894
----
## ❗️❗️Important note about iteration2 and iteration3:
- Please ensure that you have included this mapsApiKey and newsAPIKey in .env👇:
- mapsApiKey="AIzaSyD53Fbwb06wlLX5hJIS0aRNnvhRYZXxT5c"
- newsAPIKey="a1a6d062c00e441e8fb5ce6c581b025f"
We allocated our work so that Cathy has three functionalities to implement: Image, Auth, 3rd party API. Serena has three functionalities: location and notifications, 3rd party API.
Cathy plans to do more work in iteration 1 and 2, so she can relax in the last week. Serena will do more work in iteration 2 and 3.
Our total comtribution will be approximately 50:50.
----
## Iteration 3:
In iteration 3 we implemented functionalities of external APIs and Notification use. We also fixed bugs in the second iteration about location use and rendering a scrollable view containing virtual lists. We added styling to the whole app so it looks professional.
Our users can :
- Add a to-do list, which contains several to-do items to a jobApplication record
- Issue a notification of each to-do item
- edit, save, and display user's home location , the target company's location and the user's current location
- Browse the top 3 news headlines in the job application record detail page
- Filter and quickly locate a job application record in the main view
### current state of our product:
- Add a to-do list item and issue a notification (The 10s reminder is for the convience of testing)
- 
- Edit, save and display multiple locations
- 
- Browse news in the job application record detail view
- 
- See the notes and todos in the application record detail view
- 
- Filter one job application record according to company name or postion name
- 
- 
### members contributions:
#### Cong:
- External API use (a news API)
- Added Filter to job application record list
- Some styling and UX design
#### Jieling:
- Enabled the notification functionality
- Added a todo list component, support users to add, view and delete todos in a job application record
- Multiple markers in the location functionality
----
## Iteration 2:
In iteration 2 we implemented functionalities like Authentication, Camera use and Location use.
Our users now can :
- see a welcome page to encourage them login / signup
- sent a password reset email if they forget their password when logging in
- get alerted when they are creating a weak password when signing up
- only see and modify their own job application records/notes
- sort their job application record by date or preference score
- add a note with or without taking a picture using their phone camera to the job application record
- browse user's current and company's location in a seperate page under detail mode
- edit user's current and company's location in a seperate page under edit mode
### current state of our product:
- welcome page
- 
- add a note with a picture taken
- 
- notes added to the job application record
- 
- the sorted job records list
- 
- view location info
- 
- browse location info to detail mode
- 
- edit company location
- 
- browse location info to edit mode
- 
### firebase rules of our top collection: Users Collection
```
rules_version = '2';
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if request.auth != null;
//Currently i am allowing registered users to read and write anything.
//The logic is: I am using the uid from Auth to generate the user document id in
//my Users collection. That is to say, only when users register/log in they will
//have a unique id, and they will only have access to all the records in their
//own user document and its subcollections.
//All of my stored data belongs to specific users and there is no "universal data".
}
}
}
```
### firebase rules of our storage
```
rules_version = '2';
service firebase.storage {
match /b/{bucket}/o {
match /{allPaths=**} {
allow read, write: if true
}
}
}
```
### members contributions:
#### Cong:
- Authentication
- Camera use
- some styling and added the sorting function to jobRecords
#### Jieling:
- Integrated with Google Map API
- Enbaled the Location functionality
- Styling modification
- Plan for iteration 3:
- Notification
- Enable two markers on location component
- User experience optimization
----
## Iteration 1:
In iteration 1 we implement the MVP of our project, we focus on building the skeleton of the whole project and the CRUD on JobApplicationRecords collection. Our
MVP version supports add / update / delete / browse the basic information(company name, position, status, date and perference score) of a job application record.
### current state of our product:
### members contributions:
#### Cong:
- whole skeleton of the app(screens and components)
- navigation (Stack and Tab)
- modified some styling of AddAJobApplication, added the preferenceScore selection
- created and implemented the EditJobApplication and JobApplicationDetail component
#### Jieling:
- the whole CRUD of JobApplicationRecords
- implemented the firebase set up and helper files
- implemented most of AddAJobApplication screen
- implemeneted the JobApplicationRecords screen
### Data Model in Iteration 1:
Collections and subcollections:
- users (contains document 'user')
- jobApplicationRecords (contains document 'jobApplicationRecord')
- notes (contains document 'note')
- todos (contains document 'todo')
Documents:
- user
- jobApplicationRecord
- note
- todo
The organization of the collections and documents:
- The top level of our collection is the users collection.
- Each user in users collection will have a document, which contains several properties, including the subcollection of jobApplicationRecords.
- Each jobApplicationRecord document will contain several properties, including the subcollection of notes and todos.
- Please see details of the documents below.
#### (Document)User
- email (String)
- name (String)
- profilePhoto (blob)
- numJobsSaved (int)
- numJobsApplied (int)
- numInterview (int)
- numAcceptance (int)
- numRejection (int)
- achievementLogs (list of Strings)
- badgesEarned (list of blobs)
- jobApplicationRecords (collection)
#### (Document)JobApplicationRecord
- company (String)
- postion (String)
- location (String/location object)
- preferenceScore (int, [1,10])
- URL (String,optional)
- status (Enum):
- In Progress
- Applied
- Interviewing
- Interviewed
- Offer
- Offer Accepted
- Rejected
- notes (Collection,optional)
- todos (Collection,optional)
- isFavourite (boolean)
- hasTodoDue (boolean)
- lastUpdated (datetime)
#### (Document) Note
- photo (blob)
- text (String)
#### (Document) Todo
- text (String)
- completed (boolean)
- dueDate (datetime,optional)
- notifyBefore (int,optional)