Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.32 KB

README.md

File metadata and controls

55 lines (40 loc) · 2.32 KB
Raw

oworms-ui

Hosted Application || Swagger || API Source Code || Prototype

Maintainability

Getting Started

  1. Run yarn or npm install
  2. Run ng serve --proxy-config=proxy.conf.json to point an API proxy to localhost:8080 OR
  3. Run npm run start-l OR
  4. Run yarn start-l

Development build

yarn build or npm run build

Production build

ng build --aot --configuration production

Express server

node server.js or npm start or yarn start

Angular CLI project generation

ng new oworms-ui --package-manager=yarn --routing --style=scss --prefix=ow

Note: the details you capture on the credentials page will be passed as query params (u & bna) for protected endpoints

Features

  • Viewing words, creating, updating words
  • linking tags to words
  • liking/favouriting words
  • receive an email everytime a word is created or updated
  • filtering by any of the available fields, driven by query parameters (e.g. https://oworms.herokuapp.com/o/all?pos=verb,adjective&tags=informal,politics)
  • retrieve a random word
  • view statistics on the application & the words
  • import spreadsheet of words
  • export all words to csv
  • fully responsive

Planned Features

  • allowing multiple parts of speech and definitions to be linked to one word
  • linking of synonyms and antonyms
  • ability to delete words
  • automated creation of words, adding word with assistance/wizard

Why this app?

A convenient way to store and find words. I was previously using a simple spreadsheet but as it grew, adding words proved to be inefficient and frankly annoying. Being able to store and find words my way. Sure, one can find any word in existence on the internet, but I wanted a more elegant way to view words. If I google a word and it happens to also be the name of a company, the company will appear first (thanks SEO) and not the word.