This repository contains a RESTful API designed for a questionnaire application, written in Django Rest Framework (DRF). For a simplified implementation, authentication is not implemented, and all endpoints are public.
A summary of the API can be found in the Endpoints and API Summary sections below.
As this is my first project using DRF and was done within a week, the codebase might not be as polished as it can be 😅.
A demo of this project is deployed on Heroku here. Do note that it may take up to a minute for the app to load initially, as it is deployed on Heroku's free tier.
/forms:/forms/:id:/submissions:/submissions/:id:
- The frontend will preprocess the form data or CSV file into JSON before sending information to this API
- The answers sent to the
/submissionsendpoint will be given in thedisplay_orderof questions in the specified form.
- Install a stable release of Python (e.g. version 3.8).
- Clone this repository and navigate to it using "cd" in your command line or shell tool.
- Run
pip3 install -r requirements_dev.txtto install all dependencies. - Setup the database via
python manage.py migrate. - Run
python manage.py runserverto start the server athttp://localhost:8000
- The deployment configuration for Heroku is already set up on the
herokubranch. To deploy:- Set up a new app on Heroku, and provision a Postgres database add-on
- Deploy the
herokubranch of this repository to the above app on Heroku - Run
python manage.py migrateon this Heroku app to setup the Postgres database
Before pushing to GitHub, ensure that your code is formatted and your tests are passing.
black .: Run this at the top of your project directory. Formats your code. Ensure dev dependencies are installed before running this.python manage.py test: Runs the test suite.
- Enable filtering of submissions by form id in URL parameters
- Store answers to radio and checkbox questions properly as integers in the database
- Currently, the answers to these questions are stored as text for a simplified implementation
- One possible approach to handling checkbox answers is documented here
- Authentication
- Only authenticated users can submit and/or edit their own forms
- Forms should not be editable by other users
- Only form admins can view all submissions to the form
- Implementation details will depend on usecase
- Forms can be shared with others via a unique link
Returns the form title, and form questions with their corresponding fields.
Example return:
- Note that GET
/formsreturns an array of these JSON objects
{
"id": 1,
"questions": [
{
"id": 1,
"display_order": 1,
"question": "What is your full name?",
"question_type": "textbox",
"choices": []
},
{
"id": 2,
"display_order": 2,
"question": "What is your favourite colour?",
"question_type": "checkbox",
"choices": [
{
"id": 1,
"choice": "blue",
"choice_id": 1
},
{
"id": 2,
"choice": "red",
"choice_id": 2
},
{
"id": 3,
"choice": "green",
"choice_id": 3
},
{
"id": 4,
"choice": "yellow",
"choice_id": 4
}
]
},
{
"id": 3,
"display_order": 3,
"question": "What is your most familiar coding language?",
"question_type": "radio",
"choices": [
{
"id": 7,
"choice": "python",
"choice_id": 1
},
{
"id": 8,
"choice": "java",
"choice_id": 2
},
{
"id": 9,
"choice": "ruby",
"choice_id": 3
},
{
"id": 10,
"choice": "javascript",
"choice_id": 4
},
{
"id": 11,
"choice": "golang",
"choice_id": 5
}
]
}
],
"title": "form title"
}
display_orderandchoice_idrepresent the question order within a form, and choice order within a question respectively. Both must be in running order starting from 1question_typemust be one oftextbox,checkboxorradio
Example JSON:
{
"title": "dummy form",
"questions": [
{
"display_order": 1,
"question": "What is your full name?",
"question_type": "textbox"
},
{
"display_order": 2,
"question": "What is your favourite colour?",
"question_type": "checkbox",
"choices": [
{
"choice_id": 1,
"choice": "blue"
},
{
"choice_id": 2,
"choice": "red"
},
{
"choice_id": 3,
"choice": "green"
},
{
"choice_id": 4,
"choice": "yellow"
}
]
},
{
"display_order": 3,
"question": "What is your most familiar coding language?",
"question_type": "radio",
"choices": [
{
"choice_id": 1,
"choice": "python"
},
{
"choice_id": 2,
"choice": "java"
},
{
"choice_id": 3,
"choice": "ruby"
},
{
"choice_id": 4,
"choice": "javascript"
},
{
"choice_id": 5,
"choice": "golang"
}
]
}
]
}
Returns submission answers and the corresponding form.
Example return:
- Note that GET
/submissionsreturns an array of these JSON objects
{
"id": 1,
"answers": [
{
"id": 1,
"answer": "John Doe",
"question_id": 1
},
{
"id": 2,
"answer": "2",
"question_id": 2
},
{
"id": 3,
"answer": "4",
"question_id": 3
}
],
"form_id": {
"id": 1,
"questions": [
{
"id": 1,
"display_order": 1,
"question": "What is your full name?",
"question_type": "textbox",
"choices": []
},
{
"id": 2,
"display_order": 2,
"question": "What is your favourite colour?",
"question_type": "checkbox",
"choices": [
{
"id": 1,
"choice": "blue",
"choice_id": 1
},
{
"id": 2,
"choice": "red",
"choice_id": 2
},
{
"id": 3,
"choice": "green",
"choice_id": 3
},
{
"id": 4,
"choice": "yellow",
"choice_id": 4
},
{
"id": 5,
"choice": "purple",
"choice_id": 5
},
{
"id": 6,
"choice": "pink",
"choice_id": 6
}
]
},
{
"id": 3,
"display_order": 3,
"question": "What is your most familiar coding language?",
"question_type": "radio",
"choices": [
{
"id": 7,
"choice": "python",
"choice_id": 1
},
{
"id": 8,
"choice": "java",
"choice_id": 2
},
{
"id": 9,
"choice": "ruby",
"choice_id": 3
},
{
"id": 10,
"choice": "javascript",
"choice_id": 4
},
{
"id": 11,
"choice": "golang",
"choice_id": 5
}
]
}
],
"title": "form title"
}
}
Example JSON:
- Note that the order of answers should correspond to the display order of the questions in the form
{
"form_id": 1,
"answers": [
{
"answer": "John Doe",
"question_type": "textbox"
},
{
"answer": "2",
"question_type": "checkbox"
},
{
"answer": "4",
"question_type": "radio"
}
]
}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent