{"id":25185898,"url":"https://github.com/mazensayed91/achievments-social-platform","last_synced_at":"2025-07-08T10:09:04.137Z","repository":{"id":111421773,"uuid":"409294358","full_name":"Mazensayed91/achievments-social-platform","owner":"Mazensayed91","description":null,"archived":false,"fork":false,"pushed_at":"2021-10-06T19:36:37.000Z","size":706,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-09T19:43:16.107Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://optimistic-cray-30b34c.netlify.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mazensayed91.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2021-09-22T17:21:41.000Z","updated_at":"2021-10-08T22:31:40.000Z","dependencies_parsed_at":"2023-03-13T13:40:16.332Z","dependency_job_id":null,"html_url":"https://github.com/Mazensayed91/achievments-social-platform","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/Mazensayed91%2Fachievments-social-platform","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mazensayed91%2Fachievments-social-platform/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mazensayed91%2Fachievments-social-platform/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mazensayed91%2Fachievments-social-platform/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mazensayed91","download_url":"https://codeload.github.com/Mazensayed91/achievments-social-platform/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247149460,"owners_count":20891949,"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":"2025-02-09T19:40:50.718Z","updated_at":"2025-04-04T08:44:00.917Z","avatar_url":"https://github.com/Mazensayed91.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# achievments-social-platform\n\n- This project simulates a social platform that user can post, like, delete and write achievements\n- This is a fullstack application built using MERN stack.\n\n# Client Side:\n\n## To run the client side:\n- install all project dependencies with `npm install`\n- start the development server with `npm start`\n\n## Componenet Tree:\n\n![image](https://user-images.githubusercontent.com/54520113/136267034-0926a8f4-0a59-4ea0-bc51-6165b1370777.png)\n \n## Files\n```\n├── package.json # npm package manager file.\n├── public\n│   └── index.html # has the root element\n└── src\n    ├── App.css # Styles for your app..\n    ├── App.js # This is the root of the app.\n    ├── api # Contains the API file as a best practice.\n    │   └── index.js # A JavaScript API for the backend. Instructions for the methods are below.\n    ├── components # Contains the leveraged to build the UI.\n    │   ├── Achievements.js # Represents a All the achievements.\n    │       ├── Achievement.js # Represents one achievement.\n    │   └── Auth.js # Represents auth view [signin-signup]\n    │   └── Form.js # Represents form to add achievment\n    │   └── Navbar.js # Represents the navbar of the entire app\n    │   └── Home.js # Represents the grid listing the achievments\n    │       ├── Input.js # Represents one input field.\n    ├── images # Helpful images for the app.\n    │   ├── achievement.png\n    ├── redux # Views that are rendered based on the URL.\n    │   ├── actions\n    │       ├── achievement.js\n    │       ├── auth.js\n    │   ├── constants.js\n    │   ├── reducers.js\n    │       ├── achievement.js\n    │       ├── auth.js\n    │   \n    ├── styles.css\n    └── index.js # It is used for DOM rendering only.\n```\n\n# Server Side:\n\n\n## To run the server side:\n- install all project dependencies with `npm install`\n- start the development server with `npm start`\n\n## Files\n```\n├── package.json # npm package manager file.\n├── public\n│   └── index.html # has the root element\n└── src\n    ├── App.css # Styles for your app..\n    ├── App.js # This is the root of the app.\n    ├── middleware # Contains the middlewares.\n    │   └── auth.js # auth middleware used to validate the auth of the current user before executing any action.\n    ├── models # Contains the MongoDB models.\n    │   ├── Achievements.js # Represents a All the achievements.\n    │       ├── achievementModel.js # Represents the achievement schema.\n    │       ├── userModel.js # Represents the user schema.\n    ├── routes # contains all express routes.\n    │   ├── achievements.js # contains all the routes for the achievments app\n    │   ├── user.js # contains all the routes for the user app\n    ├── controllers # Containts all the contollers of the app, aka. the logic of each api request (dealing with mongodb).\n    │   ├── achievements.js\n    │   ├── user.js\n    │   ├── actions\n    │       ├── achievement.js\n    │       ├── auth.js\n    └── index.js # It is used for app setup, express setup and mongodb setup.\n```\n\n## Backend Server\nThese are the methods you will need to perform necessary operations on the backend:\n\n* [`getAchievements`](#getAchievements)\n* [`createAchievement`](#createAchievement)\n* [`updateAchievement`](#updateAchievement)\n* [`deleteAchievement`](#deleteAchievement)\n* [`likeAchievement`](#likeAchievement)\n\n\n### `getAchievements`\n\nMethod Signature:\n\n```js\ngetAchievements()\n```\n\n* Returns a Promise which resolves to a JSON object containing a collection of achievements objects.\n\n### `createAchievement`\n\nMethod Signature:\n\n```js\ncreateAchievement(data)\n```\n* Returns a Promise which resolves to a JSON object containing the response data of the request\n\n\n### `updateAchievement`\n\nMethod Signature:\n\n```js\nupdate(id, data)\n```\n\n* Returns a Promise which resolves to a JSON object containing the response data of the request\n\n### `likeAchievement`\n\nMethod Signature:\n\n```js\nupdate(id)\n```\n\n* Returns a Promise which resolves to a JSON object containing the response data of the request\n\n### `deleteAchievement`\n\nMethod Signature:\n\n```js\ndeleteAchievement(id)\n```\n\n\n## Author: Mazen Sayed\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmazensayed91%2Fachievments-social-platform","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmazensayed91%2Fachievments-social-platform","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmazensayed91%2Fachievments-social-platform/lists"}