Code Monkey home page Code Monkey logo

notegala's Introduction

NoteGala

Build Status

NoteGala is an Android application that allows people to create, edit, and categorize notes. The client is backed by a public GraphQL API that can readily accommodate new clients or integrations.

Demo Media

You can find GIFs of the app in action here.

Architecture

System Overview

Disclaimer

The back end is a bit over-engineered for the current scale. This reflects the fact that the project is primarily an educational pursuit.

System Flow

User devices submit requests alongside Google credentials to a load-balanced API. These CRUD requests are satisfied by a backing PostgreSQL instance, which stores the majority of the system data. In addition to typical SQL queries, postgres also handles full-text search for notes.

While handling a request, the API will generate logs with standard severity levels. These logs are published to Redis channels and then picked up by logT. At that point, logs can go to two places:

  • Elasticsearch
    • All logs will end up here.
  • The email inbox of a developer
    • All (but hopefully zero) error logs end up here.

CI/CD

Jenkins performs integration and deployment for the API. A multibranch pipeline runs its tests in an isolated Docker Compose environment. If they pass, the code becomes eligible for a PR into master. Should that also succeed, the code is retested and then deployed into production. It is important that, when modifying the API, you also update its semantic version; failure to do so will result in no deployment.

Container Orchestration

Kubernetes manages the life cycle of Docker containers and their secrets. Any of the configuration files that can be put into Git will go in the cluster directory.

Cloud Infrastructure

Everything is AWS. Here's a nice list:

  • Route 53
    • Handles the DNS configuration for the project
  • RDS
    • Manages the PostgreSQL instance
  • EC2 / EBS
    • Provides node/storage resources for the cluster
  • S3
    • Stores kops information for the cluster
  • ELB
    • Provides classic load balancing for Kubernetes services
  • Elasticsearch
    • Houses Elasticsearch but also a pretty sweet Kibana instance
  • ElastiCache
    • Vehemently guards Redis
  • SNS
    • Sends email alerts containing log data

notegala's People

Contributors

mlposey avatar

Stargazers

J. Taylor avatar

Watchers

James Cloos avatar  avatar

notegala's Issues

Jenkins can't read the sed command

This command would be used to tag Docker images with the API version number. The command itself works, but Jenkins can't interpret it well enough to actually execute it. Will fix when not tired.

Docker Compose occasionally fails to delete the test database

This causes the next build to fail because the container name is already taken. A simple fix would involve adding a step before the test that deletes the container if it exists. However, it would also be nice to know when deletion fails so that the stage can clean up its own state.

Titles cannot be removed once a note is created

The API interprets an empty string as a directive to clear a title. However, it seems as though the Apollo Input type is converting empty strings to null, which tells the API that the title should not be changed. This means that, after creating a note with a title, attempts to update it with a blank title result in no action by the server.

The tags UI lacks symmetry and proper padding

  • Symmetry:
    Each tag in the list contains the tag and trash icon. They are aligned poorly. Position the tag to be left aligned, and right align the trash icons.

  • Padding:
    The tag text input consumes more vertical space than needed, creating an awkward break between the text hint and existing tags in the list view. Reduce either the padding on the input or the list view so that the two are vertically closer.

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.