Giter VIP home page Giter VIP logo

waypoints's Introduction

Waypoints CRUD

A small service demonstrating moving data from frontend to backend and vice-versa. Built from scratch (except frontend via vue-cli) with Python 3, fastapi+uvicorn+uvloop, SQLAlchemy, VueJS, Bootstrap and Postgres.

Find details about technical decisions in DECISIONS.md.

Screenshot of the UI

Table of Contents

Quickstart

  • docker-compose up, or make run then open localhost:8000 in the browser once the service has been created.
  • API docs are at localhost:8000/docs
  • Enter a waypoint as a comma separated string and click save
  • See it pop up in the table below!

Dev and Build requirements

Development

Local dev setup

  • Entrypoint for mostly everything is the Makefile
  • make dev-setup, given the requirements are fulfilled

Local dev

  • poetry shell to activate the projects virtual environment
  • make dev to bring up the development servers
    • backend and frontend have their own development servers. ports are shown via cli
  • make test to run tests via pytest
  • make lint to lint and autoformat backend and frontend
  • make load-test for simple backend load-testing facilities provided by locust.

TODO

  • Cleanup idosyncratic rest post for waypoint creation
    • parse waypoint string on frontend
    • make string parsing more robust
  • Backend: Throw error instead of silencing invalid pagination size
  • ? Use pagination package instead of hand-rolling
  • Configure for GCP Cloud run
  • fix dev env race condition

waypoints's People

Contributors

musical-avian avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.