Light

scottylabs / cmu_lost_and_found_v2 Goto Github PK

View Code? Open in Web Editor NEW

2.0 9.0 3.0 2.59 MB

CMU Lost and Found website

Dockerfile 0.32% TypeScript 90.22% JavaScript 1.29% HTML 0.98% CSS 5.44% Python 1.47% Shell 0.28%

cmu_lost_and_found_v2's Introduction

CMU Lost and Found Page

This is the code for the CMU Lost and Found Page.

cd api
npm install
npm start (or npm run dev)

In a separate terminal window, run

cd client
npm install
npm start

Now, the website should be running at localhost:3000. The API currently runs on port 3080. The client (development only) runs on port 3000. For production, build the client and deploy it with the API on port 3080.

Afterwards, you will need to create a new .env file. The .env file stores secret credentials. Run

cp .env.config .env

and fill out the fields.

To check for linting errors, in the root directory run

npx eslint .

Credits to Bhargav Bachina for template: https://medium.com/bb-tutorials-and-thoughts/how-to-develop-and-build-react-app-with-nodejs-backend-typescript-version-27a6a283a7c5 https://github.com/bbachi/react-nodejs-typescript-example

cmu_lost_and_found_v2's People

Contributors

Stargazers

Watchers

Forkers

btwj fahadhamdan1 adrastopoulos

cmu_lost_and_found_v2's Issues

[Feature] Add toggle to view archived items on page

Description

Add a page to display archived items. It should look pretty similar to the current admin page to view items.

Designs

No response

Replace bad Function type with the appropriate annotation

  // TODO: Replace bad Function type with the appropriate annotation

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/EditPermissions.tsx#L44

Fix missing React key prop in iterator

                  // TODO: Fix missing React key prop in iterator

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/EditPermissions.tsx#L94

Replace bad Function type with appropriate type

  // TODO: Replace bad Function type with appropriate type

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/NotificationSwitch.tsx#L10

Replace any type annotations with appropriate type

// TODO: Replace any type annotations with appropriate type

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/TableWidget.tsx#L1

Make images removable when editing items

Put remove photo button next to upload image button in edit item
Remove image link from the item in database -> issue with deleting items but that will be addressed with switching how we store emails

Lower the resolution of photos

Make each item card’s height be the same as the largest card’s height on the row

Condense navigation buttons into dropdown menu

Replace any annotations with appropriate types

// TODO: Replace any annotations with appropriate types

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/EditPermissions.tsx#L11

Add notification to admin when an item is submitted and waiting to be approved

Add toggle next to admins under account list to pick who receives notifications
Once item is submitted send email to the admin from 'CMU Lost and Found [email protected]'
Check that notifications for a specific item only go to users with the ability to toggle available (BLDG:ADMIN, ALL:ADMIN). For example, an item in the CUC Lost and Found would only send notifications to ALL:ADMIN and CUC:ADMIN users

Replace any with React.ChangeEvent<HTMLInputElement>

        // TODO: Replace any with appropriate type: React.ChangeEvent<HTMLInputElement>

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/SearchBar.tsx#L17

Edit image button on item card

Add a small image button that displays the corresponding item's image at the top right corner of the card

Add button that downloads all admin table data into an Excel file

Replace Function annotation with appropriate type

// TODO: Replace Function annotation with appropriate type

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/SearchBar.tsx#L5

Replace any annotations with appropriate type

// TODO: Replace any annotations with appropriate type

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/ItemCard.tsx#L1

Make website ADA compliant

Replace bad Function type with appropriate function type

// TODO: Replace bad Function type with appropriate function type

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/TableWidget.tsx#L1

Add archived field to items

Add archived field to items with an index on it in MongoDB for fast querying
Make sure front page only displays unarchived items

Replace bad type Function with appropriate type

// TODO: Replace bad type Function with appropriate type

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/UserTable.tsx#L12

[!] Add button/drop down for identifiable/not identifiable and high value/general to Add Item Form

Disable "Make Public" toggle and set to false for identifiable or high value objects
Display new labels in the admin panel table

Clean up codebase

Clean up unused imports and lint warnings

Add "filter by 90 days" functionality

Add ability to check items that are in the system for more/less than 90 days

Replace all any types with appropriate annotations

// TODO: Replace all any types with appropriate annotations

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/LoginForm.tsx#L1

Add missing React key prop

    // TODO: Add missing React key prop

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/e84b2e0b163f0710857732975b7557d51ce40956/client/src/components/HistoryAccordion.tsx#L21

Fix @typescript-eslint/no-explicit-any in Admin.tsx

// TODO: Fix @typescript-eslint/no-explicit-any in Admin.tsx

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/pages/Admin.tsx#L1

Add more buildings

Add a way to add new buildings (lost and found locations) or just add the dorm buildings

Add ability to sort on admin table by date and toggles (public, available, approve)

Sort by clicking the headers of the table

Improve notification email appearance

Ask Anuda regarding whether HTML templates can be passed into the Mailgun API

Prompt to ask whether to only display the highest level of permissions

Add button to archive all items that are > 90 days old

Add button to admin table page that archives all items > 90 days old

[Feature][Infra] Add ESLint configuration support

Description

Add ESLint to detect coding issues and errors and to improve overall quality of code.

Designs

No response

UI changes

Change logout button to red and dropdown menu button to light red where the reds match our logo colors
Move title (Carnegie Mellon University) and subtitle (Lost and Found Website) to top left align next to the logo
Increase gutter size (a.k.a. the padding on the left and right of the group of cards on the page)

Add an about/credits page

Add documentation

Automatically set the building of adding an item based on user permissions

Add ability to automatically send email when a user can be identified

Add an optional email field to the add item form to auto email the input with an email template when the “Email” button is pressed (e.g. ID cards)
Email should be sent from common email address CMU Lost and Found [email protected]
Templates are (provisionally) added as txts in “template” file. Can call and use as necessary.

Segment admin table into pages

Change admin table to be displayed in sections rather than all at once since adding more items results in an increased fetch time from database and the page needs to wait to be loaded completely

[!] Update the policy page

Clicking OK on an error message brings you back to the original page instead of redirecting to the main page

Replace any annotations with the appropriate types

// TODO: Replace any annotations with the appropriate types

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/FoundItemModal.tsx#L1

Replace bad Function type with appropriate type

  // TODO: Replace bad Function type with appropriate type

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/PublicDisplaySwitch.tsx#L12

Fix missing React key prop

                    // TODO: Fix missing React key prop

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/components/UserTable.tsx#L47

Location-based searching

Search for locations (UC, Gates) in search bar

Replace any annotations with the appropriate types

  // TODO: Replace any annotations with the appropriate types

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/e84b2e0b163f0710857732975b7557d51ce40956/client/src/components/HistoryAccordion.tsx#L13

Fix react/no-unescaped-entities lint error

// TODO: Temporarily disabled. Fix this lint issue!

https://github.com/scottylabs/cmu_lost_and_found_v2/blob/d61c957b5e35e323203e498891375c08226a9b3a/client/src/pages/Policies.tsx#L1

[!] Change login system

Login sometimes doesn't work on first try, need to reload and try again a second time
Doppler stability issues
Check with David to resolve issues with login system

Add button to archive item

Add button to archive item in admin table
Change the admin table to only display unarchived items
Create a new page that only displays archived items

Add extended history of item in admin table

Whoever approved the item -> whoever last turned on the approved toggle
Who gave out the item -> whoever last turned off the toggle under Available
All history of edits of the item

Change image storage location from Google Images

Change image storage to Google Cloud Storage Bucket and delete dead items from Google Images (because images aren’t removed upon /delete)

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.