{"id":19611666,"url":"https://github.com/hardyyb2/navigus","last_synced_at":"2025-02-26T17:26:20.845Z","repository":{"id":106170070,"uuid":"266248272","full_name":"hardyyb2/navigus","owner":"hardyyb2","description":null,"archived":false,"fork":false,"pushed_at":"2020-05-24T12:31:19.000Z","size":322,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-09T10:18:30.529Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hardyyb2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-23T02:30:13.000Z","updated_at":"2020-07-26T07:46:36.000Z","dependencies_parsed_at":"2023-06-15T21:45:47.290Z","dependency_job_id":null,"html_url":"https://github.com/hardyyb2/navigus","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardyyb2%2Fnavigus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardyyb2%2Fnavigus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardyyb2%2Fnavigus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardyyb2%2Fnavigus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hardyyb2","download_url":"https://codeload.github.com/hardyyb2/navigus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240900571,"owners_count":19875572,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T10:42:22.995Z","updated_at":"2025-02-26T17:26:20.819Z","avatar_url":"https://github.com/hardyyb2.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n### Project Structure \n1. __assets__  \n    * AdorableAvatar \n    * images\n\n2. __components__\n    * CardsComponent\n        * UsersList\n    * CurrentlyViewedUser\n    * DetailsForm\n    * Logout\n    * ProtectedRoute\n\n3. __firebase__\n\n4. __Pages__\n    * HomePage\n    * LandingPage\n    * Login\n    * NotFoundPage\n    * Signup\n\n5. __store__\n    * actions\n    * reducers\n\n6. __UI__\n    * LightToolTip\n    * MiniDrawer\n    * Modal\n    * SlideDownAnimation\n    * Spinner\n    * StyledBadge\n\n### assets\n1. __AdorableAvatar__  =\u003e  \n        Get adorable avatar from [link](https://api.adorable.io/avatars/${size}/${id})\n2. __images__ =\u003e  \n        Various images used in app including logo.\n\n### components\n1. __CardsComponent__ =\u003e\n    * _Child Components_\n        * UsersList\n    * _props_\n        * From HomePage\n            * totalUsers, type\n2. __UsersList__\n    * _Child Components_\n        * UserModal (Modal)\n        * CurrentlyViewedUser\n        * StyledBadge\n        * LightToolTip\n    * _props_\n        * From CardsComponent\n            * clients[totalUsers in parent], type\n        * From redux store\n            * totalClients, clearAvatarData(), getAvatarData()\n\n3. __CurrentlyViewedUser__\n    * _props_\n        * From UsersList\n            * handleClose()\n        * From redux store\n            * currentlyViewedUser\n\n4. __DetailsForm__\n    * _Child Components_\n        * FormInput (contains form for signup)  \n    * _props_\n        * From redux store\n            * userDetails, setUserDetails()\n    * _functions_\n        * checkValidation -  \n            validation using validator and custom validation\n        * inputChangedHandler -  \n            update form and validation status on onChange event\n5. __Logout__\n    * _props_\n        * From parent\n            * handleClose()\n        * From redux store\n            * userEmail, logout(), setTotalClients()\n\n6. __ProtectedRoute__\n    * _props_\n        * From redux store\n            * isAuthenticated, isVerifying\n\n### firebase  \n    * Contains firebase config data (apis present in local .env file)\n\n### Pages\n1.  __HomePage__\n    * _Child Components_\n        * MiniDrawer\n        * Spinner\n        * CardsComponent\n    * _props_\n        * From redux store\n            * userEmail, totalClients, totalUsers, offlineUsers, setTotalClients(), getTotalUsers()\n    * _functions_\n        * handleChange -  \n            set user type as 'online', 'offline','total','all' to see respective Cards\n\n2. __LandingPage__\n    * _props_\n        * From redux store\n           * isAuthenticated, user\n\n4. __Login__\n    * _props_\n        * From redux store\n           * isAuthenticated, user, isLoggingIn, loginError, setLogin()\n\n4. __NotFoundPage__\n    *  A 404 Page\n\n5. __Signup__\n    * _Child Components_\n        * DetailsForm\n        * SlideDownAnimation\n    * _props_\n        * From redux store\n           * isAuthenticated, user, isLoggingIn, signupError, signupErrMessage, userDetails, signupUser()\n    * _functions_\n        * handleSignUp -  \n            set up address and other details in an objesct and signupUser() \n\n### UI\n1. __LightTooltTip__     \n        Modified MaterialUi Tooltip\n\n2. __MiniDrawer__ \n    * _Child Components_\n        * Logout\n\n3. __SlideDownAnimation__\n    * _props_\n        * From parent\n            * isVisible, children, forceSlideIn, width \n\n4. __Spinner__  \n    Spinner while Loading\n\n5. __StyledBadge__  \n        Modified MaterailUI Badge\n\n\n\n### store (Redux store)\n1. __configureStore.js__ (configuring store)\n    * Middlewares\n        1. thunk (redux-thunk)\n\n2. __actions__ (redux actions)\n    * users.js (user actions)\n    * index.js (export all actions)\n    * auth.js (auth actions)\n\n3. __reducers__ (redux reducer functions \u0026 store)\n    * users.js (user reducers)\n    * index.js (combine all reducers)\n    * auth.js (auth reducers)\n\n\n### actions (Redux actions)  \n1. __auth.js__  \n    * _actions_\n        * requestLogin \n        * receiveLogin   \n            payload: user\n        * loginError     \n        * requestLogout \n        * receiveLogout \n        * logoutError  \n        * verifyRequest\n        * verifySuccess  \n        * requestSignup  \n        * signUpSuccess       \n            payload: user\n        * signUpError\n    * _actionCreators_\n        * setUserdetails  =\u003e  \n            * params - user, userDetails\n            * dispatch - signUpSuccess(on success), signUpError(on error)\n        * loginUser  =\u003e  \n            * params - email, password\n            * dispatch - requesetLogin, receiveLogin(on success), loginError(on error)\n        * logoutUser  =\u003e  \n            * dispatch - requesetLogout, receiveLogout(on success), logoutError(on error)\n        * verifyAuth =\u003e  \n            * dispatch - receiveLogin (on success)\n        * signupUser  =\u003e  \n            * params - email, password, userDetails(optional)\n            * dispatch - requesetSignup, setUserDetails(on success), signUpError(on error)\n\n        \n2. __users.js__\n     * _actions_\n        * setClients  \n            payload: clients\n        * setTotalUsers  \n            payload: users\n        * setOfflineusers  \n        * setCurrentlyViewedUser  \n            payload: user\n        * clearAvatarData  \n    * _actionCreators_\n         * setTotalClients  =\u003e    \n            * params - clients\n            * dispatch - setClients, setOfflineUsers\n        * getTotalUser  =\u003e  \n            * dispatch - setTotalUsersm , setOfflineUsers\n        * getAvatarData =\u003e  \n            * params  - clientEmail\n            * dispatch -  setCurrentlyViewedUser\n\n### reducers (Redux reducers )\n1. __users.js__\n    * state : \n        * totalClients (total Online clients)\n        * totalUsers (total users in database)\n        * offlineUsers (currently offline users)\n        * userDetails (user details object)\n2. __auth.js__\n    * state :  \n        * isLoggingIn (whether user is authenticating)\n        * isLoggingOut (in process of loggin out)\n        * isVerifying ( whether user is being verified)\n        * loginError (error returned during login ) \n        * logoutError (error during logout)\n        * isAuthenticated (whether user is authenticated)\n        * signupError (error during signup)\n        * signupErrMessage (message during signup error)\n        * user (user object received after login or signup)\n\n\n\n\n\n\n\n\n\n\n\n\u003c!-- This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `yarn start`\n\nRuns the app in the development mode.\u003cbr /\u003e\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.\u003cbr /\u003e\nYou will also see any lint errors in the console.\n\n### `yarn test`\n\nLaunches the test runner in the interactive watch mode.\u003cbr /\u003e\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n### `yarn build`\n\nBuilds the app for production to the `build` folder.\u003cbr /\u003e\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\u003cbr /\u003e\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n\n### `yarn eject`\n\n**Note: this is a one-way operation. Once you `eject`, you can’t go back!**\n\nIf you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.\n\nInstead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.\n\nYou don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.\n\n## Learn More\n\nYou can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).\n\nTo learn React, check out the [React documentation](https://reactjs.org/).\n\n### Code Splitting\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting\n\n### Analyzing the Bundle Size\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size\n\n### Making a Progressive Web App\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app\n\n### Advanced Configuration\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration\n\n### Deployment\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/deployment\n\n### `yarn build` fails to minify\n\nThis section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhardyyb2%2Fnavigus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhardyyb2%2Fnavigus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhardyyb2%2Fnavigus/lists"}