{"id":24614435,"url":"https://github.com/tabuckner/broskichat","last_synced_at":"2026-04-11T00:41:54.273Z","repository":{"id":85352588,"uuid":"142772552","full_name":"tabuckner/broskichat","owner":"tabuckner","description":"Collaborative Project for the BroskiTownUSA group.","archived":false,"fork":false,"pushed_at":"2018-08-31T18:28:13.000Z","size":942,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-01-24T21:16:48.624Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tabuckner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-07-29T15:28:49.000Z","updated_at":"2018-08-31T18:28:14.000Z","dependencies_parsed_at":"2023-03-03T03:46:12.089Z","dependency_job_id":null,"html_url":"https://github.com/tabuckner/broskichat","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/tabuckner%2Fbroskichat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tabuckner%2Fbroskichat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tabuckner%2Fbroskichat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tabuckner%2Fbroskichat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tabuckner","download_url":"https://codeload.github.com/tabuckner/broskichat/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244273399,"owners_count":20426922,"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-01-24T21:16:50.775Z","updated_at":"2025-12-31T00:14:34.162Z","avatar_url":"https://github.com/tabuckner.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BroskiChat\n[![Build Status](https://travis-ci.com/tabuckner/broskichat.svg?branch=develop)](https://travis-ci.com/tabuckner/broskichat)\n[![codecov](https://codecov.io/gh/tabuckner/broskichat/branch/develop/graph/badge.svg)](https://codecov.io/gh/tabuckner/broskichat)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n\nCollaborative project for the BroskiTownUSA group. Both API and APP directories are housed in a single repo for now. There are some project dependencies outlined below. If you have any questions or concerns feel free to reach out. Check out the [API](broskichat-api/README.md) and [APP](broskichat-app/README.md) README files.\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.\n\n### Prerequisites\n\n#### Node\nIf you dont already have Node installed, you will need it in order to use this project.\n\n[Get Node Here](https://nodejs.org/en/download/). We recommend the LTS version. If you wanna go crazy, maybe check out [NVM](https://github.com/creationix/nvm/blob/master/README.md).\n\nThen verify installation with: \n```\nnode --version\n```\n\n#### Yarn\nWe use `yarn` for this project. In the past it has been touted as being better, and has a slightly better UX in my opinion. \n\nFollow the [installation instructions](https://yarnpkg.com/lang/en/docs/install/#debian-stable) from Yarn.\n\nThen verify installation with:\n\n```\nyarn --version\n```\n\n### Installing\n\n#### Backend\n\nCD into the API directory\n\n(from project root)\n\n```\ncd broskichat-api\n```\n\nInstall\n\n```\nyarn install\n```\n\nDone.\n\n#### Frontend\n\nCD into the APP directory\n\n(from project root)\n```\ncd broskichat-app\n```\n\nInstall\n\n```\nyarn install\n```\n\nDone.\n\n## Developing!\nIn order to develop on either directory, simply change directory, and run the start script. \n**NOTE** The Frontend is dependent on the backend until we have a CI/CD process in place. If you are working on the FE you need to start the BE. \n\n### Backend\n\nchange directory\n```\ncd broskichat-api\n```\n\nstart it\n```\nyarn start\n```\n\n### Frontend\n\n*Terminal 1*\nstart the api\n```\ncd broskichat-api \u0026\u0026 yarn start\n```\n\n*Terminal 2*\nchange directory\n```\ncd broskichat-app\n```\n\nstart the app\n```\nyarn start\n```\n\n\n## Running the tests\n\n**NO CI/CD PROCESS YET**\n\n### E2E\n\nNONE YET\n\n```\n\u003c...\u003e\n```\n\n### STYLE\n\nNONE YET\n\n```\n\u003c...\u003e\n```\n\n## Design Tenets\n\n* Must be responsive for all screen sizes\n* Must match theme\n* Pretty\n* Make use of bulma classes\n\n## Deployment\n\nNo deployment process yet.\n\n## Built With\n\n* [LoopBack](https://loopback.io/) - Backend Framework\n* [React](https://reactjs.org/) - Frontend Framework\n* [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) - DB\n* [Bulma](https://bulma.io/)- CSS Framework\n\n## Contributing\n\nTo make a contribution to the project simply open a PR and we will review!\n\nTo become a member of the team please contact us by opening an issue in the github repo. \n\n## Authors\n\n* **Taylor Buckner** - *Initial work* - [tabuckner](https://github.com/tabuckner)\n* **TEAM MEMBER** - *ROLE* - [githubprofile](#)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftabuckner%2Fbroskichat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftabuckner%2Fbroskichat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftabuckner%2Fbroskichat/lists"}