Feedback

.circleci/config.yml

@@ -7,9 +7,8 @@ jobs:
   build-and-test-express-js:
     docker:
       - image: cimg/node:16.13.0 # latest stable node at the time of writing
-        # auth:
-        #   username: mydockerhub-user
-        #   password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
+    environment:
+      JWT_SECRET: test
     steps:
       - checkout
       - run: echo "this is the build and test express.js job"
@@ -24,9 +23,6 @@ jobs:
   build-react-js:
     docker:
       - image: cimg/node:16.13.0 # latest stable node at the time of writing
-        # auth:
-        #   username: mydockerhub-user
-        #   password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
     steps:
       - checkout
       - run: echo "this is the build react.js job"
@@ -46,4 +42,4 @@ workflows:
       - build-and-test-express-js
   build-front-end:
     jobs:
-      - build-react-js
+      - build-react-js

.github/ISSUE_TEMPLATE/spike-template.md

@@ -2,16 +2,10 @@
 name: Spike Template
 about: A template to use for Spikes
 title: ''
-labels: spike
+labels: Spike
 assignees: ''
 
 ---
 
-## Estimation of work
-- TBD
+## Research topic:
 
-## Acceptance criteria
-- [ ] foo
-- [ ] bar
-- [ ] etc
-- [ ] etc

.github/ISSUE_TEMPLATE/task-template.md

@@ -2,7 +2,7 @@
 name: Task Template
 about: A template to use for Tasks
 title: ''
-labels: task
+labels: Task
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/user-story-template.md

@@ -1,8 +1,8 @@
 ---
 name: User Story Template
 about: A template to use for User Stories
-title: ''
-labels: user story
+title: 'As a , I want , so that '
+labels: User Story
 assignees: ''
 
 ---
@@ -11,7 +11,4 @@ assignees: ''
 - TBD
 
 ## Acceptance criteria
-- [ ] foo
-- [ ] bar
-- [ ] baz
-- [ ] etc
+- TBD

.gitignore

@@ -26,15 +26,64 @@
 *.sql
 *.sqlite
 
-# OS generated files #
-######################
+# macOS generated files #
+#########################
+
+# General
 .DS_Store
-.DS_Store?
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
 ._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
 .Spotlight-V100
+.TemporaryItems
 .Trashes
-ehthumbs.db
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Windows generated files #
+###########################
+
+# Windows thumbnail cache files
 Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
 
 # Typical Node.js artifacts #
 #############################
@@ -117,10 +166,12 @@ typings/
 # next.js build output
 .next
 
-
 ## Emacs artefacts ##
 *~
 
 ## Jekyll artifacts
 **/.jekyll-cache
-**/_site/
+**/_site/
+
+.idea
+./front-end/node_modules

CONTRIBUTING.md

@@ -1,2 +1,72 @@
-# Guide to Contributing
-Delete the contents of this file and replace with the contents of a proper guide to contributing to this project, as described in the [instructions](./instructions.md)
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a Team Norms section discussing code of conduct, please follow it in all your interactions with the project.
+
+## Build and Testing Process
+
+See [README.md](./README.md).
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
+2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
+3. You may merge the Pull Request into the `main` branch once you have the permission of other developers.
+
+## Team Norms
+
+Below are a set of rules each team member must follow to establish a productive and positive environment.
+
+Teams are ideally co-located in the same room or space while they work for fast interactions and rapid team building... or work harder to make sure collaboration takes place with dedicated chat rooms, video conferencing and conference calls.
+
+### Team Values
+
+Team members are expected to display a right-minded attitude to ensure a positive environment.
+
+Examples of behavior that contributes to creating a positive environment include:
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+When a team member needs help due to extenuating circumstances, it is important reach out and notify all other team members as soon as possible, preferably a few days before any deadlines.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to these values, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, unproductive, threatening, offensive, or harmful.
+
+### Sprint Cadence
+
+Sprints will take place over a period of two weeks, after which all maintainers will discuss their contributions in the Sprint Review.
+
+### Daily Standups
+
+Daily standup times will be flexible according to times when all team members have an open schedule. Each standup will take approximately 30 minutes, and all maintainers are expected to present synchronously. Members will not cover for other members who do not participate.
+
+A member who makes no progress on a task for two standups or more in a row will be reported to management.
+
+### Coding Standards
+
+- All team members will use VS Code and a designated linter to standardize code formatting.
+- Use hyphen in file names.
+    - Do: UX-DESIGN.md
+    - Don't: UX_DESIGN.md
+- Don't over-engineer. Write minimum code to get things working end to end, only then iterate to improve.
+  - Code for each task and spike must be peer-reviewed and pass tests before merging into the `main` branch of code.
+- Always push working code, if you break the pipeline/build then fix it.
+- Make granular and small commits, per feature or per bug fix.
+- Provide descriptive commit messages.
+- Write self documenting code. Use descriptive variable and function names. Avoid unnecessary name shortening.
+- Don't leave dead/commented out code behind. If you see such code, delete it.
+- Write automated tests to cover critical integration points and functionality (once you learn how to do that).
+
+## Concluding thoughts
+
+These listed rules and regulations are crucial for long-term progress, so it is important that all members follow everything as a baseline requirement. Everyone has their own unique qualities and offerings. Thus, any activity beyond these rules are allowed and encouraged as long as they are ethical and pragmatic. At the end of the day, we want all contributors to feel included, motivated and gratified. Happy coding! 

instructions-0c-project-setup.md → Instructions/instructions-0c-project-setup.md

@@ -41,18 +41,18 @@ GitHub repositories have been created for each team and are in the control of th
 
 #### README.md
 
-Every project must have a [README.md](./README.md) that automatically renders on the project's main repository page with basic details of the project, including:
+Every project must have a [README.md](../README.md) that automatically renders on the project's main repository page with basic details of the project, including:
 
 - a description of project, including the [Product Vision Statement](https://knowledge.kitchen/Scrum_development_framework#Product_vision_statement)
 - the core team members, including links to their GitHub accounts and any other web presence they have
-- a short history of how the project came to be and information about how to contribute to the project (i.e. a link to the [CONTRIBUTING.md](./CONTRIBUTING.md) document)
+- a short history of how the project came to be and information about how to contribute to the project (i.e. a link to the [CONTRIBUTING.md](../CONTRIBUTING.md) document)
 - instructions for building and testing the project (update with that information once the project reaches that stage)
 - links to any additional Markdown documents or web pages that may be relevant reading about the project
 - anything else you think is important to communicate to people viewing the project
 
 #### CONTRIBUTING.md
 
-Each team must collaboratively draft a [CONTRIBUTING.md](./CONTRIBUTING.md) - a Markdown document exclusively dedicated to how others might contribute to this project. This document is essentially a contract agreed-upon by all developers and contributors, and includes at a minimum:
+Each team must collaboratively draft a [CONTRIBUTING.md](../CONTRIBUTING.md) - a Markdown document exclusively dedicated to how others might contribute to this project. This document is essentially a contract agreed-upon by all developers and contributors, and includes at a minimum:
 
 Details on the team's values and process:
 
@@ -68,7 +68,7 @@ GitHub provides a link to this document automatically to any user who creates a
 
 #### .gitignore
 
-Each repository must have a [.gitignore](./.gitignore) file that informs git not to track platform code, 3rd party library code, and other common development artifacts that are not your own code. It is also imperative to not track files that contain sensitive information, such as usernames/passwords to a database, or files containing users' personal information.
+Each repository must have a [.gitignore](../.gitignore) file that informs git not to track platform code, 3rd party library code, and other common development artifacts that are not your own code. It is also imperative to not track files that contain sensitive information, such as usernames/passwords to a database, or files containing users' personal information.
 
 Use [this example .gitignore file for Node.js-based web apps](https://gist.github.com/bloombar/1bbca4aafb267920ac220864d99d6c8f) as the baseline for your .gitignore file.
 

README.md

@@ -1,19 +1,57 @@
-# Project Repository
+[![CircleCI](https://circleci.com/gh/software-assignments-spring2022/final-project-codehunt/tree/master.svg?style=shield)](https://circleci.com/gh/software-assignments-spring2022/final-project-codehunt/tree/master)
+![last commit](https://img.shields.io/github/last-commit/software-assignments-spring2022/final-project-codehunt?logo=Github)
+![license](https://img.shields.io/github/license/software-assignments-spring2022/final-project-codehunt?logo=GitHub)
+
+<h2>Deployed URL</h2>
+<a href="http://157.245.90.75:4000/">Click me</a>
+
+<h2>Product Vision Statement</h2>
+<h4>What and why?</h4>
+CodeHunt is a information hub for users in the Computer Science field. In the information age, information overload slows our productivity. There are excessive events/contest occurring on multiple web contest websites, such as LeetCode, CodeForces, Kaggle. It's time-consuming to keep track of all the events by bouncing from website to websites. Our goal is to build a webapp that collects and aggregates information on the user's behalf. All they need to do is login to CodeHunt and see the pages that they have subscribed to and feature events. 
+We want to give Computer Science students the opportunity to receive an offer from their dream company and dream job. Students regularly participating in coding contests and events is one step closer to that dream title. Struggling students are overwhelmed when started searching for contests, and even if they did, keeping up to date with the events and maintaining their schedule is inconvenient and unproductive. Our product distribute the resource that allow users to be educated beyond the classrooms.
+
+<h4>For whom?</h4>
+The end-users are Computer Science enthusiasts and students. Due to limited resources, we provide limited service to CS students at NYU. Narrowing our target will allow us to work with what we are familiar with, so the product best suits the end-users. In the future we will extend the service to anyone interested in CS related events, coding contests, job positions, and the world-wide web.
+
+<h2>CodeHunt is maintained by</h2>
+<ul>
+<li><a href="https://github.com/charliecai00"> Charlie Cai</a></li>
+<li><a href="https://github.com/dinanz">Diana Zhao</a></li>
+<li><a href="https://github.com/kopokopok">Michael Zhou</a></li>
+<li><a href="https://github.com/dana-sun">Dana Sun</a></li>
+<li><a href="https://github.com/andrewshin02">Andrew Shin</a></li>
+</ul>
+
+<h2>Building and installing CodeHunt</h2>
+
+<h3>Get the code</h3>
+<ol>
+  <li>git clone https://github.com/software-assignments-spring2022/final-project-codehunt</li>
+  <li>Navigate into the project directory</li>
+</ol>
+
+<h3> Build and launch the back end</h3>
+<ol>
+  <li>cd back-end</li>
+  <li>touch .env</li>
+  <li>copy code from .env.example to .env</li>
+  <li>npm install</li>
+  <li>npm start</li>
+</ol>
+
+<h3> Build and launch the front end</h3>
+<ol>
+  <li>cd front-end</li>
+  <li>touch .env</li>
+  <li>copy code from .env.example to .env</li>
+  <li>npm install</li>
+  <li>npm start</li>
+</ol>
+
+<h2>Help wanted</h2>
+We have several ideas we would like to see in CodeHunt to make it even better. However, we already work on so many things that we do not have the time for all the big ideas.
+
+This can be your way to support and contribute to CodeHunt - extend it to do something cool.
+
+For everyone who wants to contribute (and send pull requests), please read our [contributing guidelines](./CONTRIBUTING.md) before you submit.
 
-This repository will be used for team projects.
-
-Several sets of instructions are included in this repository. They should each be treated as separate assignments with their own due dates and sets of requirements.
-
-1. See the [App Map & Wireframes](instructions-0a-app-map-wireframes.md) and [Prototyping](./instructions-0b-prototyping.md) instructions for the requirements of the initial user experience design of the app.
-
-1. Delete the contents of this file and replace with the contents of a proper README.md, as described in the [project setup instructions](./instructions-0c-project-setup.md)
-
-1. See the [Sprint Planning instructions](instructions-0d-sprint-planning.md) for the requirements of Sprint Planning for each Sprint.
-
-1. See the [Front-End Development instructions](./instructions-1-front-end.md) for the requirements of the initial Front-End Development.
-
-1. See the [Back-End Development instructions](./instructions-2-back-end.md) for the requirements of the initial Back-End Development.
-
-1. See the [Database Integration instructions](./instructions-3-database.md) for the requirements of integrating a database into the back-end.
-
-1. See the [Deployment instructions](./instructions-4-deployment.md) for the requirements of deploying an app.

UX-DESIGN.md

@@ -1,8 +1,41 @@
-# User Experience Design
+<h1>Prototype</h1>
+<a href='https://d121902.invisionapp.com/console/share/SMBRGPKW5TF'>Prototype</a>
 
-This repository contains instructions and files for two assignments that together comprise the user experience design phase of a web app.
+# App map
+![My image](./ux-design/app-map/app-map.png)
 
-Replace the contents of this file with the completed assignments, as described in:
+### Explanation
+Each box represents a unique design template. The home page is the list of feature contests by default. The contest view has two viewing option. The count-down view displays the events in future time accenting order. The calendar view displays events in calendar mode. The user and setting page is integrated under one template. The about me view displays information of the team and link to GitHub.
 
-- [app map & wireframe instructions](instructions-0a-app-map-wireframes.md).
-- [prototype instructions](instructions-0b-prototyping.md)
+# Wireframes
+
+### Home
+![My image](./ux-design/wireframe/Wireframe-Home.png)
+### Explanation
+The default page showing feature contests.
+
+### Contests (list view)
+![My image](./ux-design/wireframe/Wireframe-List.png)
+
+### Contests (calendar view)
+![My image](./ux-design/wireframe/Wireframe-Calendar.png)
+### Explanation
+This is a calendar view. At the top are navigation bar, logo, and user profile, which are consistent. The grey boxes represent the time slots in weekly view. The grey box 1-7 represents the days in a week. On the left, a bar indicates the time in each day. 
+
+### User setting
+![My image](./ux-design/wireframe/Wireframe-User-Settings.png)
+
+### User sign up
+![My image](./ux-design/wireframe/Wireframe-Signup.png)
+
+### User log in
+![My image](./ux-design/wireframe/Wireframe-Login.png)
+
+### Password reset
+![My image](./ux-design/wireframe/Wireframe-Forget-Pswd.png)
+
+### About us
+![My_image](./ux-design/wireframe/Wireframe-About-Us.png)
+
+### Navigation bar
+![My_image](./ux-design/wireframe/Wireframe-NavBar.png)