https://github.com/pybites-open-source/questionnaire-api

💡 Questionnaire REST API
https://github.com/pybites-open-source/questionnaire-api

api flask hacktoberfest python3 questionnaire-api quiz swagger-ui

Last synced: 11 months ago
JSON representation

💡 Questionnaire REST API

Host: GitHub
URL: https://github.com/pybites-open-source/questionnaire-api
Owner: PyBites-Open-Source
License: mit
Created: 2019-10-06T16:43:00.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2019-11-05T19:13:54.000Z (over 6 years ago)
Last Synced: 2025-03-22T15:12:05.331Z (11 months ago)
Topics: api, flask, hacktoberfest, python3, questionnaire-api, quiz, swagger-ui
Language: Python
Homepage: https://pybites-open-source.github.io/questionnaire-api/
Size: 547 KB
Stars: 28
Watchers: 5
Forks: 10
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

          


  



[![Open Issues](https://img.shields.io/github/issues/PyBites-Open-Source/questionnaire-api?style=for-the-badge)](https://github.com/PyBites-Open-Source/questionnaire-api/issues) [![Forks](https://img.shields.io/github/forks/PyBites-Open-Source/questionnaire-api?style=for-the-badge)](https://github.com/PyBites-Open-Source/questionnaire-api/network/members) [![Stars](https://img.shields.io/github/stars/PyBites-Open-Source/questionnaire-api?style=for-the-badge)](https://github.com/PyBites-Open-Source/questionnaire-api/stargazers) ![Build](https://img.shields.io/travis/PyBites-Open-Source/questionnaire-api?style=for-the-badge) ![Maintained](https://img.shields.io/maintenance/yes/2019?style=for-the-badge&logo=github)  ![Made with Python](https://img.shields.io/badge/Made%20with-Python-blueviolet?style=for-the-badge&logo=python)  ![Open Source Love](https://img.shields.io/badge/Open%20Source-%E2%99%A5-red?style=for-the-badge&logo=open-source-initiative)  ![Built with Love](https://img.shields.io/badge/Built%20With-%E2%99%A5-critical?style=for-the-badge&logo=ko-fi) [![PyBites/Opentrivia](https://img.shields.io/badge/PyBites%2FOpentrivia-Chat-success?logo=slack&style=for-the-badge)](https://app.slack.com/client/T4SJVFM8C/CMYR582R4)

`THIS PROJECT IS UNDER ACTIVE DEVELOPMENT, README MAY CHANGE EVERY ONCE IN A WHILE`

## Index

- [Index](#index)

- [About](#about)

- [Usage](#usage)

  - [Installation](#installation)

- [File Structure](#file-structure)

- [Guideline](#guideline)

- [Gallery](#gallery)

- [Endpoints](#endpoints)

- [Credit/Acknowledgment](#creditacknowledgment)

- [License](#license)

## About

This will be a free to use, open sourced questions database which has a REST API implemented in Python3 & Flask using PostgresSQL database, also this will be a source for a minimal quizzing website which will also let contributors add new questions in multiple categories and as MCQ or T/F types. 

## Usage

To use this project.

### Installation

**Development**

If you want just to do a simple test run of the application, you can install and use it 

with development config.

- Clone the repository

```bash

$ git clone https://github.com/PyBites-Open-Source/questionnaire-api.git

```

- Create the virtualenv and activate it

```bash

$ cd questionnaire-api

$ python -m venv virtualenv

$ source virtualenv/bin/activate # unix

$ .\virtualenv\Scripts\activate  # windows

```

- Install requirements

```bash

$ pip3 install -r ./src/requirements.txt

```

- Create database and apply migrations

```

$ cd src && flask db upgrade

```  

- Run the application

```bash

$ cd src && flask run

```

**Production**

In order to use postgresql database ready for production, you need to use docker and to add some additional environment variables. 

- Setup database 

```bash

# create .env file wihtin src folder with the following environment variables. 

POSTGRES_USER="trivia"

POSTGRES_PASSWORD="trivia"

POSTGRES_DB_PROD="opentrivia_prod"

POSTGRES_DB_TEST="opentrivia_test"

DB_PORT="5432"

DB_HOST="localhost"

# if you want to change these settings you have to change also the init.sql file 

# from db folder. 

```

- Run the application

```bash

$ cd src && docker-compose up

```

## File Structure

- Add a file structure here with the basic details about files, below is an example.

```

.

├── docker

│   ├── api-server

│   │   └── Dockerfile

│   └── db-server

│       └── Dockerfile

├── logo

│   └── opentrivia.png

├── src

│   ├── app

│   │   ├── api

│   │   │   ├── routes

│   │   │   │   ├── __init__.py

│   │   │   │   ├── answers.py

│   │   │   │   ├── categories.py

│   │   │   │   └── questions.py

│   │   │   ├── tests

│   │   │   │   ├── __init__.py

│   │   │   │   ├── test_answers.py

│   │   │   │   ├── test_categories.py

│   │   │   │   └── test_questions.py

│   │   │   └── __init__.py

│   │   ├── models

│   │   │   ├── __init__.py

│   │   │   ├── answer.py

│   │   │   ├── category.py

│   │   │   └── question.py

│   │   ├── static

│   │   │   └── swagger.json

│   │   ├── templates

│   │   │   ├── base.html

│   │   │   ├── developer.html

│   │   │   └── home.html

│   │   ├── __init__.py

│   │   └── views.py

│   ├── db

│   │   └── init.sql

│   ├── instance

│   │   └── dev_opentrivia.db

│   ├── migrations

│   │   ├── versions

│   │   │   └── 798672a50ee1_.py

│   │   ├── README

│   │   ├── alembic.ini

│   │   ├── env.py

│   │   └── script.py.mako

│   ├── tests

│   │   ├── __init__.py

│   │   └── test_opentrivia.py

│   ├── config.py

│   ├── docker-compose.yml

│   ├── requirements.txt

│   └── run.py

├── CONTRIBUTING.md

├── LICENSE

├── README.md

└── _config.yml

```

## Guideline

- __Code Style__

In order to maintain the code style consistency across entire project we use a code formatter. Therefore, we kindly suggest you to do the same whenever you push commits to this project. 

The python code formatter we chose is called black. Black is a great tool and it can be installed quickly by running 

`pip install black`.  

or

`python3.6 -m pip install black`

It requires Python 3.6.0+ to run.

- __Usage__

`black {source_file_or_directory}`

For more details and available options, please check the [GitHub project](https://github.com/psf/black).

- __Close Issues__

Close issues using keywords: [how to ?](https://help.github.com/en/articles/closing-issues-using-keywords)

## Gallery



  



## Endpoints

`Available Views`

- [x] http://127.0.0.1:5000/            #Home Page

- [x] http://127.0.0.1:5000/developer   #Developer Page

- [x] http://127.0.0.1:5000/swagger/    #Swagger UI

`Available Endpoints`

- Questions

    - [x] `GET api/v1/questions` **(Get all Questions)**

    - [x] `GET api/v1/questions/` **(Get Question)**

    - [x] `POST api/v1/questions` **(Create new Question)**

    - [x] `PUT api/v1/questions/` **(Update Question)**

    - [x] `DELETE api/v1/questions/` **(Delete Question)**

- Answers 

    - [x] `GET api/v1/answers/` **(Get Answer)**

    - [x] `POST api/v1/answers` **(Create new Answer)**

    - [x] `PUT api/v1/answers/` **(Update Answer)**

    - [x] `DELETE api/v1/answers/` **(Get Category)**

    - [x] `POST api/v1/categories` **(Create new Category)**

    - [x] `PUT GET api/v1/categories/` **(Update Category)**

    - [x] `DELETE GET api/v1/categories/` **(Delete Category)**

feel free to add more functionalities

endpoint url structure:  **/api/v1/. . .**

## Credit/Acknowledgment

[![Contributors](https://img.shields.io/github/contributors/PyBites-Open-Source/questionnaire-api?style=for-the-badge)](https://github.com/PyBites-Open-Source/questionnaire-api/graphs/contributors)

## License

[![License](https://img.shields.io/github/license/PyBites-Open-Source/questionnaire-api?style=for-the-badge)](https://github.com/PyBites-Open-Source/questionnaire-api/blob/master/LICENSE)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/pybites-open-source/questionnaire-api

Awesome Lists containing this project

README