Idiom

a web application to generate unique randomized words & phrases with api endpoints support built with

❯ Usage

I start learning the most beloved framework Sveltekit and that's what i'm using in the frontend

You can test the api in the demo application app https://iidiom.vercel.app

idiom supports 8 word types that can be used to form a phrase:

• adjective
• adverb
• animal
• bodyParts
• gerunds
• pluralNouns
• verbs (imperative mood)

Additional Features

When placed at the beginning of a phrase, the word a will be transformed into an if the second word in the phrase begins with a vowel (i.e. a/an squid/octopus). You can also use any additional words to form a phrase like the, it, is, etc.

Forming a phrase

To form a phrase, connect the type(s) of words you want with a @. For example, to form a phrase consisting of a verb, the, and a plural noun, you would use the following:the @pluralNoun is @gerund

API

You can make a GET request to https://idiom-api.su.ysnirix.xyz/api/PHRASE, where PHRASE is the type of phrase desired.

curl --request GET \
  --url 'https://idiom-api.su.ysnirix.xyz/api/the%20@pluralNoun%20is%20@gerund'

Example response

{
  "message": "🎉 done",
  "error": false,
  "code": 200,
  "results": "the oranges is striking"
}

Development

Once you've cloned the project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

Client

# for the client
cd client
npm run dev
# or start the Client and open the app in a new browser tab
npm run dev -- --open

# for the server
cd server
npm run dev

Production

# for the client
cd client
npm run build

# for the server
cd server
npm start

You can preview the built client app with npm run preview,This should not be used to serve your app in production.

❯ About

Pull requests and stars are always welcome. For bugs and features requests, please create an issue.

Author

Ysn4Irix

• GitHub Profile
• Instagram Profile

❯ License

Copyright © 2022-present, Ysn4Irix. Released under the MIT License.