{"id":20281315,"url":"https://github.com/khayyamsaleem/client-connect","last_synced_at":"2025-04-11T06:55:22.451Z","repository":{"id":84782909,"uuid":"156573605","full_name":"khayyamsaleem/Client-Connect","owner":"khayyamsaleem","description":"Client Connect: a platform that connects clients with nearby freelancers","archived":false,"fork":false,"pushed_at":"2018-12-26T23:42:36.000Z","size":577,"stargazers_count":6,"open_issues_count":3,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-09T22:57:24.991Z","etag":null,"topics":["express","mongodb","mongoose","nextjs","nodemon","react","redis","semantic-ui-react","socket-io","winston-logger","yarn"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/khayyamsaleem.png","metadata":{"files":{"readme":"README.org","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":"2018-11-07T16:11:47.000Z","updated_at":"2022-11-06T15:41:20.000Z","dependencies_parsed_at":"2023-03-06T08:31:06.574Z","dependency_job_id":null,"html_url":"https://github.com/khayyamsaleem/Client-Connect","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/khayyamsaleem%2FClient-Connect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khayyamsaleem%2FClient-Connect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khayyamsaleem%2FClient-Connect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khayyamsaleem%2FClient-Connect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khayyamsaleem","download_url":"https://codeload.github.com/khayyamsaleem/Client-Connect/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248358555,"owners_count":21090402,"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":["express","mongodb","mongoose","nextjs","nodemon","react","redis","semantic-ui-react","socket-io","winston-logger","yarn"],"created_at":"2024-11-14T13:43:02.067Z","updated_at":"2025-04-11T06:55:22.434Z","avatar_url":"https://github.com/khayyamsaleem.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"#+TITLE: CS554 Final Project: Client Connect\n#+OPTIONS: toc:nil num:nil\n#+STARTUP: showall\n\n#+html: \u003cp\u003e\u003cimg src=\"./assets/ClientConnectLogo.svg\" width=\"400px\" /\u003e\u003c/p\u003e\n\n* Group Members\n- Khayyam Saleem, Michael Iacona, Maxwell Melo, Annie Topoleski\n  \n* [[https://www.youtube.com/watch?v=xrswrNRgohs][Demo Video]]\n\n* Getting Started\n** Setup\n*** With Docker (easy)\n- Ensure you have docker installed:\n  - macOS: ~brew cask install docker~, then run ~Docker.app~ from ~Applications folder~\n  - Linux:\n      #+BEGIN_SRC bash\n       curl -fsSL https://get.docker.com/ | sh\n       sudo usermod -aG docker $USER\n       sudo systemctl start docker\n      #+END_SRC\n  - Windows: Find a tutorial somewhere...\n- Clone the repository:\n  #+BEGIN_SRC bash\n    git clone https://github.com/khayyamsaleem/cs554-final-proj\n    cd cs554-final-proj\n  #+END_SRC\n- Create a .env file. For non-prod environments, you can just rename ~.env.sample~ to ~.env~ to get started.\n- In .env, change ~MONGO_URL_TEST~ to \"mongodb://mongo:27017/clientconnect\"\n- Run \n  #+BEGIN_SRC bash\n    git checkout -b feature/\u003cfeature-name\u003e # e.g feature/chat-client\n    docker-compose up --build\n  #+END_SRC\n*** Without Docker (annoying)\n- Clone the repository as above.\n- Create a .env file. For non-prod environments, you can just rename ~.env.sample~ to ~.env~ to get started.\n- Ensure that you have ~yarn~, ~nodemon~, ~redis-server~, and ~mongod~ installed on your machine.\n- In a separate terminal, start a mongo server (~mongod~)\n- In a separate terminal, start a redis server (~redis-server~)\n- In a separate terminal, run these commands:\n  #+BEGIN_SRC bash\n    git checkout -b feature/\u003cfeature-name\u003e # e.g. feature/chat-client\n    yarn install\n    yarn dev:start\n  #+END_SRC\n** Contributing\n- Take a look at the [[https://github.com/khayyamsaleem/Client-Connect/blob/master/docs/contribution.org][contribution tutorial]].\n\n* Stack\n- mongo, express, react (Next.js), node *(MERN)*\n- socket.io for messaging\n- redis for chat caching\n- mongoose for schema definition\n- Semantic UI for rendering\n- winston for logging\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhayyamsaleem%2Fclient-connect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhayyamsaleem%2Fclient-connect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhayyamsaleem%2Fclient-connect/lists"}