Skip to content

GuilhermeAB/find-me-monorepo

Repository files navigation

Find-Me

Find-Me is a web application designed to help find missing people and pets. It provides a platform where users can create and search for missing person or pet reports, and collaborate with others to increase the chances of finding them.

Online demo: click here

Features

  1. Create and manage missing person or pet reports
  2. Search for existing missing person or pet reports
  3. Collaborate with other users by providing information or updates on reports
  4. Mark reports as resolved when the missing person or pet is found
  5. User authentication and authorization
  6. Responsive and user-friendly interface

Technologies Used

  1. Yarn 3 (PnP)
  2. Typescript
  3. Node.js
  4. Fastify
  5. MongoDB
  6. Mongoose
  7. JSON Web Tokens (JWT)
  8. Vue 3
  9. Vuetify 3
  10. Vuex 4
  11. Vue Router 4
  12. Axios

Project setup

Required:

  1. Node.js LTS
  2. Yarn

Create and update the environment files (ex: backend/auth/.env, backend/alert/.env, frontend/web/.env)

# Run auth project
yarn auth
# Run alert project
yarn alert
# Run web project
yarn web

Contributing

Contributions are welcome! If you want to contribute to Find-Me, please follow these steps:

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes.
  4. Commit and push your changes.
  5. Create a pull request.

License

This project is licensed under the MIT License.