Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gitegob/broadcaster
Broadcaster 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 any other things that need government intervention
https://github.com/gitegob/broadcaster
backend corruption css frontend heroku html javascript
Last synced: 2 months ago
JSON representation
Broadcaster 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 any other things that need government intervention
- Host: GitHub
- URL: https://github.com/gitegob/broadcaster
- Owner: gitegob
- Created: 2019-10-25T13:08:44.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-30T19:00:22.000Z (about 2 years ago)
- Last Synced: 2023-03-12T00:27:05.598Z (almost 2 years ago)
- Topics: backend, corruption, css, frontend, heroku, html, javascript
- Language: HTML
- Homepage: https://brian-broadcaster.herokuapp.com
- Size: 6.08 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BroadCaster
[](https://travis-ci.org/gitego-brian/BroadCaster) [](https://coveralls.io/github/gitego-brian/BroadCaster) [](https://codeclimate.com/github/gitego-brian/BroadCaster/maintainability)
Broadcaster 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.
## [Documentation](https://documenter.getpostman.com/view/8741834/SW7Z48w7)
# API Endpoints included
- **POST /auth/signup:** Create an account
- **POST /auth/signin:** Log into your account
- **POST /records/:** Create a new record
- **GET /records/:recordID:** Fetch a single record
- **GET /records:** Fetch all records
- **GET /records/red-flags:** Fetch all red-flag records
- **GET /records/interventions:** Fetch all intervention records
- **PATCH /records/:recordID:** Update a record
- **DELETE /records/:recordID:** Delete a record
# Installation and Environment Setup
**Clone the repository from [Github](https://github.com/gitego-brian/BroadCaster).**
( You will need **Git** for this if you are running a Windows PC, Get it [HERE](https://git-scm.com/) )
```
git clone https://github.com/gitego-brian/BroadCaster.git
```
**To Install all dependencies:**
```
npm install
```
**To run the tests:**
```
npm run test
```
**Now to start the app:**
```
npm run start
```
**To start the app in development mode:**
( You need **nodemon** installed for this, run `npm i -g nodemon` to install it )
```
npm run dev
```
Test the endpoints in your favorite API client, I strongly recommend [Postman](https://www.getpostman.com/) though :ok_hand:
## Sample Request
### Request body for sign up
```js
{
"firstName": "John",
"lastName": "Smith",
"email": "[email protected]",
"password": "complicatedPswd@111",
"userName": "jsmith",
"phone": "+112233445566"
}
```
### Response body for signup
```js
{
"status": 201,
"message": "User created successfully",
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MiwiZmlyc3ROYW1lIjoiQmVuIiwibGFzdE5hbWUiOiJHaXNhIiwiZW1haWwiOiJnaXRlZ29iN0B5YWhvby5jb20iLCJpc0FkbWluIjpmYWxzZSwiaWF0IjoxNTc0MTczOTk1fQ.aEsCstbsBKGiGCGhF5GrShADpbxnTpq6wSBKXLlhIU"
}
}
```
# Tools used
- Server-Side Framework: **Node/Express**
- Linter: **ESLint**
- Style Guide: **Airbnb**
- Testing framework: **Mocha/Chai**
# More Tools
- Continuous integration: **[Travis-Ci](travis-ci.org)**
- ES6 Transpiler: **[Babel](babeljs.io)**
- Test coverage: **[nyc](https://www.npmjs.com/package/nyc)**
- Maintainability: **[Code climate](https://codeclimate.com)**
- Deployment: **[Heroku](https://www.heroku.com)** and **[Github pages](https://pages.github.com)**
# Deployments
- The UI template is hosted on Github pages at https://gitego-brian.github.io/BroadCaster/UI
- The API is hosted on Heroku at http://brian-broadcaster.herokuapp.com/
# Contribute
If 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:
Assumming you have the repo cloned on your PC,
- Pull the latest changes to the remote repo by running:
```
git pull origin develop
```
NB: You need to be on the develop branch when you do this
- Create & switch the new branch where you will add your changes by running:
```
git checkout -b yournewbranchname
```
- 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.
# Author:
**Brian GITEGO**