diff --git a/README.md b/README.md index af2fa39..63ad689 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,30 @@ # Paws Lost and Found by Jianming Tu -## description -This is web app for finding the lost pets or the owner who lost pets. The app provides the user authentication and authorization for creating a post of lost or find; provides a searching engine for easily narrowing down the need. +## Description +This is a web app for finding the lost pets or the owner who lost pets. The app provides the user authentication and authorization for creating a post of lost or find; provides a searching engine for easily narrowing down the need. -## technologies +## Tech Stack + use react, express and mongodb, deploying on netlify(front end app), Heroku(Node express) and mongoDB altas and save the images on AWS s3 bucket, using React, Bootstrap, Material-ui, font-awesome -* use react, express and mongodb, deploying on netlify(front end app), heroku(Node express) and mongodb altas and save the images on AWS s3 bucket, using React, Bootstrap, Material-ui, font-awesome - * netlify : https://eloquent-archimedes-c44224.netlify.app/ - * Heroku: https://fathomless-lake-61399.herokuapp.com/api +## Deployed on Netlify + https://eloquent-archimedes-c44224.netlify.app/ -## App Layer +## Deployed on Heroku + https://fathomless-lake-61399.herokuapp.com/api + +## App Layers client - React (Netlify) server - Express (Heroku) database -MongoDB -## install server +## Server Installation https://github.com/BCIT-SSD-2020-21/passion-project-jianmingtu/tree/main/client -## server install +## Server Installattion https://github.com/BCIT-SSD-2020-21/passion-project-jianmingtu/tree/main/server - +## User Experience ![](https://i.imgur.com/sW2ter8.png) ![](https://i.imgur.com/88agZx5.png) diff --git a/client/README.md b/client/README.md index 02aac3f..b819cab 100644 --- a/client/README.md +++ b/client/README.md @@ -1,4 +1,4 @@ -# Getting Started with Create React App +# Client Side Install, Debug and Deployment This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). @@ -68,3 +68,7 @@ This section has moved here: [https://facebook.github.io/create-react-app/docs/d ### `yarn build` fails to minify This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) + +## Debug + NPM start -> Copy URL + CTRL+SHIFT+D -> Select Debug URL -> Paste the copied URL -> it will run to debugging breakpoints diff --git a/server/README.md b/server/README.md index 19d8dd8..2e8ad77 100644 --- a/server/README.md +++ b/server/README.md @@ -1,4 +1,4 @@ -# server +# Server Side Install, Debug and Deployment ## Server Layer server - Express (Heroku) @@ -7,7 +7,7 @@ database -MongoDB npm init npm install -g nodemon npm i pstree.remy@1.1.0 -D - npm i express morgan body-parser dotenv mongodb bcryptjs jsonwebtoken + npm i express morgan body-parser dotenv mongodb bcryptjs jsonwebtoken - create server.js, etc. - deploy heroku login @@ -30,21 +30,19 @@ database -MongoDB add "start": "node server.js" to package.json git add . git commit -m "change xxx" - git subtree push --prefix server heroku master (build https://fathomless-lake-61399.herokuapp.com) + git subtree push --prefix server heroku master (build https://fathomless-lake-61399.herokuapp.com) => push to Heroku Github git branch --show-current - git push origin 1ServerSetup + git push origin 1ServerSetup => My Personal GitHub https://blog.logrocket.com/5-ways-to-make-http-requests-in-node-js/ -- 5 ways of http requests and I choose the most popular axios -## debug on the local express +## Debug on the local Express run code . the server folder - click on the `run and debug` - select Node from the list - go to the breakpoint and will get the debug interrupt + CTRL+SHIFT+D -> Select 'Run and Debug' -> Choose Node.js -> It will run into breakpoints -## debug on Heroku (the CLI will keep an alive logging) +## Debug on Heroku (the CLI will keep an alive logging) heroku login heroku logs --app=fathomless-lake-61399 --tail