Giter Club home page Giter Club logo

s4-11-ft-mern's Introduction

We know our pets love to be active and sometimes play on the streets💖🐶, normally when they are exploring the enviroment get lost😞. Pet Finder is commited to help you find your best friend as soon as possible.🔍😻


You can check out our webpage here:


✔ Requirements 📋

1 - You will have to create a .env in Front and Back folders

2 - You will have to create you own database in Mongo website

3 - You will have to create you own account for nodeMailer

4 - You will have to create you own account for Cloudinary

5 - You will have to create you own account for Google Maps

6 - Install the dependencies with npm install at Back and Front folders

7 - Run the server with npm run dev (development) or npm start (production)

Back .env
PORT = Number of the port where you wanna run api (ex. 4000).
DB = For Db in MongoDB.
SECRET_KEY : Is the secret key used for JWT.
BASE_URL = localhost of you api ( ex. http://localhost:5173).
EMAIL_PASSWORD = The Password of the email used in Nodemailer.
EMAIL_API = The email there you want to use in Nodemailer.
Front .env
VITE_APP_ID_CLIENT_GOOGLE = For use Login with Google.
VITE_APP_GMAPS_API_KEY = For use Google Maps Api.

VITE_APP_MAILCHIMP_URL = For use mailchimp for send newsletter email.

VITE_APP_PRESET_USER = preset to upload user photos in cloudinary.
VITE_APP_PRESET_PRODUCTS = preset to upload products photos in cloudinary.
VITE_APP_PRESET_ADOPT_PETS= preset to upload pets photos in cloudinary.

VITE_APP_CLOUDNAME = name of your cloudinary.

VITE_APP_API_ROUTE = Localhost of you api ( ex. http://localhost:4000).

✔ Backend

👉🏻 Task List ✅

  • Development of Rest Api for Lost and Found pets with NodeJs, TypeScript and Express.
  • Validations with Express Validator.
  • MongoDb Database.
  • Creating filters with Mongoose and regular expressions.
  • Users validation wiith JWT and Google.
  • Sending emails with Nodemailer for contact, welcome and password recovery.
  • Signing up subscribers for Newsletter with Mailchimp.
  • Deployed on Heroku

👉🏻 Built with 🛠️

NodeJS Express.js TypeScript MongoDB Mongoose JWT Mailchimp Nodemailer Heroku

👉🏻 Developers

Yamila Paez Nora Saucedo

✔ Frontend

👉🏻 Task List ✅

  • Development of the view through dynamic components with Javascript and React.
  • Adding style with Material UI components, tables and elements.
  • Creating the linked routes of the page using React Router.
  • Formik, Yup, Axios and Redux to control and submit form data.
  • Using Google Oauth API as Login alternative.
  • Using Google Maps API to show dinamical maps and Location Autocomplete.
  • obtaining and uploading images of pets with Cloudinary.
  • Visual and attractive animations added with Framer Motion.
  • Deployed on Vercel.

👉🏻 Built with 🛠️

JavaScript React Redux MUI Framer Motion Formik Yup React Router Google Maps Api Vercel

👉🏻 Developers

Jeyther Yriza Daniel Albanez Saira Arteaga Francisco Rey LuMi

✔ UI/UX

👉🏻 Built with 🛠️

Figma Cloudinary

👉🏻 Designer

Andres Fuentes

👉🏻 Team Leader

Alejandro Cardenas

Communication

s4-11-ft-mern's People

Contributors

bellantra avatar jeyther avatar franrey98 avatar danielalbanez40 avatar davaloslm avatar smirart1 avatar lupydev avatar norsauce avatar

Watchers

 avatar

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

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

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.