{"id":21612554,"url":"https://github.com/gitegob/broadcaster-server","last_synced_at":"2025-03-18T16:28:32.969Z","repository":{"id":43903898,"uuid":"276979673","full_name":"gitegob/BroadCaster-server","owner":"gitegob","description":"BroadCaster server","archived":false,"fork":false,"pushed_at":"2023-03-03T11:25:54.000Z","size":1965,"stargazers_count":2,"open_issues_count":14,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-01-24T20:19:54.241Z","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/gitegob.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-07-03T20:11:27.000Z","updated_at":"2022-02-03T20:07:02.000Z","dependencies_parsed_at":"2024-11-24T21:23:21.634Z","dependency_job_id":"1ebcdb97-8266-4cd0-8db9-d15ce9e62e8e","html_url":"https://github.com/gitegob/BroadCaster-server","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/gitegob%2FBroadCaster-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitegob%2FBroadCaster-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitegob%2FBroadCaster-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitegob%2FBroadCaster-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitegob","download_url":"https://codeload.github.com/gitegob/BroadCaster-server/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244259098,"owners_count":20424496,"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-24T21:21:43.888Z","updated_at":"2025-03-18T16:28:32.945Z","avatar_url":"https://github.com/gitegob.png","language":"JavaScript","readme":"# BroadCaster\n\n[![Maintainability](https://api.codeclimate.com/v1/badges/d9bdd095911059b8917a/maintainability)](https://codeclimate.com/github/gitego-brian/BroadCaster-server/maintainability)\n\nBroadcaster enables any/every citizen to bring any form of corruption to the notice of appropriate authorities and the general public. Users can also report on things that need government intervention.\n\n![Screenshot (1)](https://user-images.githubusercontent.com/53472419/69162345-5cbb1b80-0aa1-11ea-912f-1831b908f0b0.png)\n\n## [Documentation](https://documenter.getpostman.com/view/8741834/SW7Z48w7)\n\n# API Endpoints included\n\n- **POST /auth/signup:** Create an account\n- **POST /auth/login:** Log into your account\n- **POST /records/:** Create a new record\n- **GET /records/:recordID:** Fetch a single record\n- **GET /records:** Fetch all records\n- **GET /records/red-flags:** Fetch all red-flag records\n- **GET /records/interventions:** Fetch all intervention records\n- **PATCH /records/:recordID:** Update a record\n- **DELETE /records/:recordID:** Delete a record\n\n# Installation and Environment Setup\n\n**Clone the repository from [Github](https://github.com/gitego-brian/BroadCaster).**\n\n( You will need **Git** for this if you are running a Windows PC, Get it [HERE](https://git-scm.com/) )\n\n```\ngit clone https://github.com/gitego-brian/BroadCaster.git\n```\n\n**To Install all dependencies:**\n\n```\nnpm install\n```\n\n**To run the tests:**\n\n```\nnpm run test\n```\n\n**Now to start the app:**\n\n```\nnpm run start\n```\n\n**To start the app in development mode:**\n\n( You need **nodemon** installed for this, run `npm i -g nodemon` to install it )\n\n```\nnpm run dev\n```\n\nTest the endpoints in your favorite API client, I strongly recommend [Postman](https://www.getpostman.com/) though :ok_hand:\n\n## Sample Request\n\n### Request body for sign up\n\n```js\n{\n    \"firstName\": \"John\",\n    \"lastName\": \"Smith\",\n    \"email\": \"jsmith@gmail.com\",\n    \"password\": \"complicatedPswd@111\",\n    \"userName\": \"jsmith\",\n    \"phone\": \"+112233445566\"\n}\n```\n\n### Response body for signup\n\n```js\n{\n    \"status\": 201,\n    \"message\": \"User created successfully\",\n    \"data\": {\n        \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MiwiZmlyc3ROYW1lIjoiQmVuIiwibGFzdE5hbWUiOiJHaXNhIiwiZW1haWwiOiJnaXRlZ29iN0B5YWhvby5jb20iLCJpc0FkbWluIjpmYWxzZSwiaWF0IjoxNTc0MTczOTk1fQ.aEsCstbsBKGiGCGhF5GrShADpbxnTpq6wSBKXLlhIU\"\n    }\n}\n```\n\n# Tools used\n\n- Server-Side Framework: **Node/Express**\n- Linter: **ESLint**\n- Style Guide: **Airbnb**\n- Testing framework: **Mocha/Chai**\n\n# More Tools\n\n- Continuous integration: **[Travis-Ci](travis-ci.org)**\n- ES6 Transpiler: **[Babel](babeljs.io)**\n- Test coverage: **[nyc](https://www.npmjs.com/package/nyc)**\n- Maintainability: **[Code climate](https://codeclimate.com)**\n- Deployment: **[Heroku](https://www.heroku.com)** and **[Github pages](https://pages.github.com)**\n\n# Deployments\n\n- The UI template is hosted on Github pages at https://gitego-brian.github.io/BroadCaster/UI\n\n- The API is hosted on Heroku at http://brian-broadcaster.herokuapp.com/\n\n# Contribute\n\nIf you ever have an idea on how you might help improve the app, yo are welcome to contribute your changes to the repository, Just follow the steps below:\n\nAssumming you have the repo cloned on your PC,\n\n- Pull the latest changes to the remote repo by running:\n\n```\ngit pull origin develop\n```\n\nNB: You need to be on the develop branch when you do this\n\n- Create \u0026 switch the new branch where you will add your changes by running:\n\n```\ngit checkout -b yournewbranchname\n```\n\n- After adding your changes, commit and push them then create a pull request for against the develop branch. I will review and merge them if they are helpful.\n\n# Author:\n\n**Brian GITEGO**\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitegob%2Fbroadcaster-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitegob%2Fbroadcaster-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitegob%2Fbroadcaster-server/lists"}