Simple Feature Request App. This app let's employees create feature requests after speaking with clients.
Docker and Docker Compose
Move into the feature-request-api folder and run
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt
export FLASK_APP=app
flask run
Move to web-app folder and execute
python -m SimpleHTTPServer
Access the web app at https://localhost:8000/
NOTE Here python
refers to the python2 binary while python3
refers to the python3 binary.
Move to the feature-request-api folder and run
pytest
NB If not deploying locally, please change baseUrl to point to your backend server else the frontend will try query the wrong server when deployed.
Make sure you have Docker Compose installed.
- Clone the project
git clone https://github.com/ivange94/feature-request.git
- cd feature-request
- docker-compose up
Visit http://0.0.0.0:8000/ to access the frontend web app.
If you would like to play with the backend API then you can access it at http://0.0.0.0:5000/
The Backend Service will be running at Endpoints exposed
- POST http://0.0.0.0:5000/api/tickets Creates a new Ticket(feature request). Sample JSON
{
"title": "Test",
"description": "Test",
"client": "Client C",
"product_area": "Policies",
"target_date": "2019-09-19",
"priority": 7
}
-
PUT http://0.0.0.0:5000/api/tickets updates a ticket. Pass in the ticket in the json body.
-
GET http://0.0.0.0:5000/api/tickets Get's a list of tickets
-
GET http://0.0.0.0:5000/api/tickets/{ID} Get's a single ticket with given ID
-
DELETE http://0.0.0.0:5000/api/tickets/{ID} Delete's ticket with ID.
- Flask - Backend API was built in Flask with extensions.
- jQuery - jQuery was used in the frontend to make ajax calls to the backend
- SQLite Database used.
- SQLAlchemy ORM
A demo of this app can be accessed here Feature Request
This project is licensed under the MIT License - see the LICENSE.md file for details