Powered by Netlify Functions, this API will provide two random 'friendly words' from the curated lists of Glitch words, perfect for file names or user names.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
To get this API running locally you will need:
- a node package manager (yarn or npm)
- a command line terminal (iTerm or bash)
- your favorite IDE (vscode, sublime)
Clone the repo:
git clone https://github.com/RickBr0wn/friendly-words-api <YOUR_PROJECT_NAME> && cd <YOUR_PROJECT_NAME>Please credit this API if you build something fantastic!
No test scripts available (yet!)
Hitting this endpoint will return the 'friendly words':
https://friendly-words-api.netlify.app- node - As an asynchronous event-driven JavaScript runtime, Node.js is designed to build scalable network applications.
- prettier - Prettier is n opinionated code formatter, that supports many languages, integrates with most editors & has few options.
- eslint - ESLint statically analyzes your code to quickly find problems. It is built into most text editors and you can run ESLint as part of your continuous integration pipeline.
- typescript - TypeScript is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
- netlify - Netlify is a cloud platform for building, deploying, and managing modern web projects.
- friendly-words - This package returns the curated lists of Glitch words, as used in project names and elsewhere.
- Rick Brown - Initial work - RickBr0wn
This project is licensed under the MIT License - see the LICENSE.md file for details