Skip to content

openwell/questioner

Repository files navigation

Questioner

Build Status Coverage Status Maintainability Test Coverage

Crowd-source questions for a meetup.

Questioner helps the meetup organizer prioritize questions to be answered.

Getting Started

Clone the Repo.

Run npm install to install all necessary packages.

Prerequisites

The following tools will be needed to run this application successfully:

Node v8.11.3 or above

Npm v5.6 or above

ENDPOINTS

  • POST /api/v1/meetups Create an meetup record.
  • GET /api/v1/meetups Fetch all meetup records.
  • GET /api/v1/meetups/upcoming/ Fetch all upcoming meetup records.
  • GET /api/v1/meetups/:meetupId Fetch a specific meetup record.
  • GET /api/v1/meetups/user/statistic Fetch a user Total Comments and Questions.
  • POST /api/v1/meetups/:meetupId/rsvps Respond to meetup RSVP.
  • GET /api/v1/meetups/rsvps Get a Single User RSVP.
  • POST /api/v1/questions Create a question for a specific meetup.
  • GET /api/v1/questions Fetch all questions.
  • GET /api/v1/questions/topfeed Fetches the top Questions of a User attending a Meetup.
  • GET /api/v1/questions/:questionId Fetches a Single question with Comments Attached to it.
  • PATCH /api/v1/questions/:questionId/upvote Upvote (increase votes by 1) a specific question.
  • PATCH /api/v1/questions/:questionId/downvote Downvote (decrease votes by 1) a specific question.
  • POST /api/v1/auth/signup Create a user account.
  • POST /api/v1/auth/login Login a user
  • POST /api/v1/auth/admin Login as an admin
  • POST /api/v1/comments/ Comment on a question.
  • GET /api/v1/comments/:questionId/ Comment on a question.
  • DELETE /api/v1/meetups/:meetupId Delete a meetup.
  • GET /api/v1/docs Api Documentation.

Installing

On your Local Machine

  • Pull the develop branch off this repository
  • Install postgreSql 11 on your local machine or registered on any online platform
  • Rename the sample.env file to .env and input the right configurations
  • Run npm i to install all dependencies
  • Run npm database to create the database tables and create an admin
  • Run npm start to start the app
  • The Admin is required to login with the data in the now .env file
  • App runs on port 3000
  • Access endpoints on localhost:3000

Running the tests

Run npm test in the terminal for the cloned folder.

Break down into end to end tests

  • It tests the API end-point.
  • It tests the REST API functionality

Deployment on Heroku Server

https://questioner1.herokuapp.com/api/v1

Hosted UI

https://openwell.github.io/questioner/UI

Built With

Authors

  • Ojo Timileyin

Acknowledgments

Releases

No releases published

Packages

 
 
 

Contributors