Broadcaster

A simple backend for Broadcaster

Simple but powerfully made . Evaluation Criteria: The system must have:

• Home page
• Login
• Sign up
• About red-flag and intervention
• News User Dashboard
• Profile Page
• Support for different user levels such as admin and citizen page

As for the backend, the language used is nodejs.

Frontend tools

• HTML
• CSS
• Javascript

Broadcaster Available endpoints

URL	HTTP Methods	Description
api/v1/auth/signup	POST	Create user account
api/v1/auth/signin	POST	Login a user
api/v1/incident	POST	Create an incident(redflag/ intervention)
api/v1/incident/<:incident-id>/comment	PATCH	Update an incident comment(red-flag/intervention)
api/v1/incident/<:incident-id>/location	PATCH	Update a specific incident location(red-flag/intervention)
/api/v1/incident/<:incident-id>	DELETE	Delete an incident(red-flag/intervention)
api/v1/red-flags	GET	Get all Redflags
/api/v1/red-flags/<:incident-id>	GET	View a specific Redflag
api/v1/interventions	GET	Get all interventions
/api/v1/interventions/<:incident-id>	GET	View a specific intervention

Installation and Environment Setup

Clone the repository from Github

( You will need Git for this if you are running a Windows PC, Get it HERE )

git clone https://github.com/shaazk/Broadcaster.git

To Install all dependencies:

npm install

To run the tests:

npm test

Now to start the app:

npm start

To start the app in development mode:

npm run dev

Backend Tools used

• Server side Framework: Node/Express
• Linting Library: ESLint
• Style Guide: Airbnb
• Testing Framework: Mocha

Host online

• Github pages here
• Heroku here
• Pivot Tracker story here

Getting started with Application

Prequesite for project

• Text Editor Microsoft Visual studio code
• Nodejs environment
• Postman API development
• Github bash terminal

Installation

• visit the repository on github
• clone the repository in terminal
• cd Broadcaster to navigate inside repository

Start Application

update packages by installing dependencies

npm install or npm i

start local server of application on PORT 4000

npm run dev

API URL

Now, to run your app locally and access resources, we will have to use the endpoint URL below as an illustration. Example http://localhost:4000/api/v1/auth/signup

http://localhost:4000/api/v1/

Test App

The app is designed with Test Driven Development(TDD). To see how it works, run the command below in your terminal.

npm test

API Documentation

• visit postman API here

Feedback

• Any found issue, raise it on github

Version

• The Broadcaster is v1.0

License

• issued by Mutesi Sharon Kiiza
• free open source## Getting Started