You can find the mockups here

Requests is part of a larger application. It allows the staff of an imaginary company to register and track clients' feature requests.

See Requests running here

• Python 3.7+ - Python interpreter
• Pip (Should be installed along with Python) - Python package manager
• Nodejs - Javascript server-side Virtual Machine
• NPM (Should be installed along with Nodejs) - Nodejs package manager
• PostgreSQL - Database management system

• Clone the repository

  git clone https://www.github.com/appcypher/requests.git

• Change working directory to project's directory

  cd requests

• Create requests and requests_test databases

• Install dependecies and build project

  . requests.sh build

• Activate the project's virtual environment.

  pipenv shell

• Apply migration files.

  flask db upgrade -d server/migrations

• Add seeds to the database.

  flask model seed all

• Start the flask app

  flask run

• Visit localhost:5000 on your browser to see the page.

• Same as installation requirements.

• You can run all the tests in a single command.

  pipenv run pytest

  Some useful defaults are already set in pytest.ini file

• The tests are all unit tests, so you can run them individually

  pipenv run pytest -k test_client_model_gets_all_rows_correctly_after_saving

• Docker

• Start all the project's containers together with docker-compose

  docker-compose -f docker/compose.yml up

• You can also build and start them individually

• Build and start flask app container

  docker image build -t flask-app:latest -f ./docker/app/Dockerfile ./

  docker container create --name flask-app -p 80:80 flask-app

  docker container start flask-app

• Build and start nginx server container

  docker image build -t nginx-server:latest -f ./docker/server/Dockerfile ./docker/server/

  docker container create --name nginx-server -p 80:80 nginx-server

  docker container start nginx-server

This project contains a buildspec.yml file for automating deployment. The deployment process relies on a few AWS automation services like CodePipeline and CodeBuild. Ideally the buildspec file needs to be customized for your use case. However, if you are willing to take the manual approach, you can follow the steps below.

• AWS - Amazon web services
• Github - Git repository hub
• AWS EB CLI - Command line tool for managing Amazon Elastic Beanstalk (EB) applications remotely

• For the following to work, you need to have configured your AWS CLI using your EC2 keypairs.

• Initialize the platform by following the prompt given by

  eb init

• Create an environement.

  eb create request_app_environment
  

• Deploy the application.

  eb deploy

• flask model seed all → Seeds the database with relevant initial data
• npm run build:prod → Builds the frontend code with optimizations turned on and generates a sourcemap
• npm run build:dev:watch → Watches the frontend code for any change and rebuilds with debug options enabled
• sh requests.sh --help → Shows helpful information about requests.sh script
• sh requests.sh build → Downloads and builds the projects dependencies
• sh requests.sh start → Starts the flask application using a Gunicorn (wsgi) server

• A detailed documentation of the API is available here.

• The project's Postman collection can be accessed with the button below.

  

• This project doesn't do any user authentication, it is assumed the larger app has this figured out already.

• GET: /api/v1/requests → Gets all the requests
• POST: /api/v1/requests → Saves a request
• GET: /api/v1/requests/:id → Gets the request with the specified id

• GET: /api/v1/requests/:id/comments → Gets all the comments under a request
• POST: /api/v1/requests/:id/comments → Adds a new comment under a request

• GET: /api/v1/staff/:id → Gets the staff with the specified id

• GET: /api/v1/client/:id → Gets the client with the specified id

• Figma → Cloud-based design tool

• Knockout → MVVM-based JavaScript library
• JQuery → A fast, small and feature-rich JavaScript library
• Webpack → Package bundler with minification
• SCSS → Flexible superset of CSS

• Flask → Micro web framework for Python
• SQLAlchemy → SQL database ORM
• Marshmallow → Serialization and validation tool
• Gunicorn → WSGI-compliant web server
• Nginx → Web server for reverse proxying, load balancing, caching and more

• PostgreSQL → Database management system

• Docker → Container and image creation and management tool
• CircleCI → Continous integration services
• CodeClimate → Code maintenance and coverage services
• Coveralls → Code coverage report services
• Amazon ECS & Elastic Beanstalk → Amazon's container orchestration services
• Amazon CodePipeline, CodeBuild, CodeCommit → A set of AWS automation services for CI/CD

• Pytest → Testing framework

This project looks nicer; thanks to the free icons and logos provided by these awesome creators

Apache License 2.0