https://github.com/pgalias/train-ticket-machine
https://github.com/pgalias/train-ticket-machine
tailwindcss typescript vue
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pgalias/train-ticket-machine
- Owner: pgalias
- Created: 2020-10-26T20:01:04.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-01-16T04:06:25.000Z (about 3 years ago)
- Last Synced: 2025-02-01T21:16:28.783Z (about 1 year ago)
- Topics: tailwindcss, typescript, vue
- Language: TypeScript
- Homepage: https://train-ticket-machine.netlify.app
- Size: 1.96 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](undefined)
See application [here](https://train-ticket-machine.netlify.app)
## Table of Contents
* [About the project](#about-the-project)
* [Built with](#built-with)
* [Getting started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Available commands](#available-commands)
* [More information](#more-information)
* [Running application](#running-application)
* [Further changes](#further-changes)
* [Contact](#contact)
## About the project
This is a small user interface of a train ticket machine. These machine has a direct but unreliable connection to the
central system and use a touchscreen display which works as follows.
As the user types each character of the station's name on the touchscreen, the display should:
1. Update keyboard to show all valid choices for the next character.
2. List of possible matching stations.
### Built with
- [Typescript](https://www.typescriptlang.org/)
- [Vue 3](https://v3.vuejs.org/)
- [Vite](https://github.com/vitejs/vite) as a project bundler and webserver
- [Tailwind](https://tailwindcss.com/)
- [Jest](https://jestjs.io/) for unit tests
- [Cypress](https://www.cypress.io/) for e2e tests
## Getting started
### Prerequisites
To use this project there is `yarn` package manager needed.
### Installation
To install all dependencies just run `yarn` command.
### Available commands
- `dev` it runs dev server with HMR
- `build` it creates dev bundle
- `test:unit` it runs unit tests with jest
- `test:e2e` it runs e2e tests with cypress
- `test` it runs two above commands at once
- `lint:scripts` it runs eslint
- `lint:styles` it runs stylelint
- `lint` it runs two above commands at once
- `cypress:open` it opens cypress application
- `build-to-branch` it builds application and deploy it to gh-pages branch
### More information
Project has [husky](https://github.com/typicode/husky) attached to check every commit. It is running eslint, stylelint
and [commit lint](https://github.com/conventional-changelog/commitlint). Husky is also running unit tests on every push
command.
## Running application
1. Run application: `yarn dev`
2. Navigate to `localhost:3000`
## Further changes
- Add dependency injection library to improve service maintenance
- Make list component more common
- Change static texts in component to translatable texts
- Add virtual list for stations list to improve performance
- Add router
- Add state manager
## Contact
Pawel Galias - [linkedin](https://linkedin.com/in/pawgalias) - [pawel@galias.me](pawel@galias.me)
Project Link: [https://github.com/pawgalias/train-ticket-machine](https://github.com/pawgalias/train-ticket-machine)
Project Demo: [https://train-ticket-machine.netlify.app](https://train-ticket-machine.netlify.app)