Code Monkey home page Code Monkey logo

tech-front's Introduction

tech-front

An email app, which accepts the necessary information to send emails.

Problem & Solution

This app solves the problem of an email client. It provides a simple, easy to use interface with support for offline work.

The solution is split across two repos, this one (the front end) and the back end. It's a full-stack solution, however the back end is in its infancy.

The front-end is built on a Vue.js framework; which makes use of:

  1. vuex for state management
  2. Element for UI
  3. Jest for unit tests
  4. Nightwatch for E2E tests

The main architectural choice for Vue.js came down to the simplicity of the framework. I find it's the easiest JavaScript framework to read and write, so it seemed ideal for this app.

The choice for Vuex was simple. Vuex provided a scalable option for state management... At this point, the app can only send emails. With Vuex, scaling into a full-blown email client is within reach.

Element was actually my second choice, originally I considered Vuetify, but decided against it as I felt it was oversized for what the project required (or could require in the future).

Jest and Nightwatch are fast and easy to write testing frameworks. I don't claim to be an expert in testing, but I found Jest has a particularly easy-to-write api for testing Vue components.

One feature within the app is the locally stored options for showing / hiding the 'cc' and 'bcc' fields. Ideally this feature would store the user's choices on the backend (associated to their user account). However, since there are no user accounts at this point, I've decided to trade this off and use local storage instead.

Features

  1. Multiple recipients (across To, CC & BCC)
  2. Offline sync (PWA)

Build Setup

First clone, install and run the backend

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production (minification is disabled)
npm run build

Tests

Make sure you have the Java Developers Kit installed before running the E2E tests.

# run unit tests
npm run unit

# run e2e tests
npm run e2e

# run all tests
npm test

tech-front's People

Watchers

James Cloos 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.