Jish2 / lifefind

Introducing Lifefind, the first app that helps college students find lost items. Make a post about your lost item along with descriptors and potential locations, and you will be alerted when found.

Lifefind Opensource!

Opensource repo for Lifefind, the first app that helps college students find lost items.
lifefind.co

View Demo · Report Bug · Request Feature

Table of Contents

• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgments

About The Project

Context

Lifefind was built as a hackathon project in 36-hours for HackIllinois 2023 (Devpost). Although not a winning project, I felt like the idea had potential and decided to pursue it as an open source project.

What is Lifefind?

Lifefind is an app & website that helps college students find lost items. Everyday, many students lose and find items, but there is no centralized platform to organize item recovery. If you lost an item, make a post about what you lost along with descriptors (such as color etc) and any potential locations. Now, when someone finds the item, they can easily locate the owner of the item. Results are refined by category, and geolocation.

(back to top)

Roadmap

• Map fully integrated
• UI Designs complete
• Sorting Feature
• No route validation
• Feature Request lifefind.co/feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Built With

Frontend	Backend	API Services	Libraries
Next.js	ExpressJS	Cloudinary	SWOT
Chakra-UI	MongoDB	SendGrid
react-icons		Twilio

(back to top)

Getting Started

To run this locally, follow these simple steps.

Prerequisites

• NPM 9.5+
• Google Cloud API Key (with Places and Maps Javascript API enabled)
• Empty MongoDB Atlas Project
• Cloudinary API Key
• SendGrid API Key

Installation

Once you have acquired API keys for all of the services above, clone the project.

git clone https://github.com/Jish2/lifefind.git

After cloning, install npm into the client and server directory.

Run this command after you cd into the cloned repo.

cd client; npm install; cd ../server; npm install; cd ..

Next, configure the environment variables for the client and server.

For the client, create a .env.local file. Add the following variable, replacing the key with your Google Cloud API key.

NEXT_PUBLIC_GOOGLE_MAPS_API_KEY="<GOOGLE CLOUD API KEY>"

For the server, create a .env file.

PORT=3001
MONGO_URI="<MONGODB URI>"
SECRET="<ENTER ANYTHING HERE. FOR JWT TOKEN.>"

GOOGLE_MAPS_API_KEY=<GOOGLE CLOUD API KEY>

CLOUDINARY_API_KEY=<CLOUDINARY API KEY>
CLOUDINARY_API_SECRET=<CLOUDINARY API SECRET>

Also, create a .sendgrid.env file.

export SENDGRID_API_KEY='SG.<SENDGRID API KEY>'

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Please do not hesistate to reach out! If you don't get a response quickly, try me on another platform. I normally respond within 48 hours, your message may have gone to spam!.

Joshua Goon

• Email: [e-mail]
• LinkedIn: Joshua Goon
• Instagram: @jgoon3
• Discord: jgoon#9043

(back to top)