Skip to content

mbos2/is-odd-or-even

Repository files navigation

Is Odd Or Even

This is Odd OrEven application ran by Appwrite cloud function., on Appwrite platform.
Currently working demo: On this link

About

This project is a simple URL Shortener service.
It contains a form with URL and Alias inputs.

In URL input you add your URL you want shorten.
In Alias input you write something with what will you recognize what Short URL represents. It is only arbitrary.

It contains a button that can fetch your Short URLs from a database into the table on the same page.

Here is a project preview: Is Odd Or Even Preview

Services

This project contains services:

  • Preview of UI form and number checker
  • It will rickroll you if you send invalid value 3 times in a row

Project Setup

Manual Setup

  • Fork this repository
  • Clone it locally
  • Change project ID inisde appwrite.json file to your project ID.
  • While in root folder, run appwrite cli command appwrite deploy function and follow steps to deploy it
    • If you don't have appwrite cli installed, check this link and install it on your device

Development

This project is developed with:

  • Typescript
  • appwrite-node
  • HTML, CSS and JS for template

Refer to Package JSON file

How to start with development

  • Locally, go to functions/is-odd-or-even path.
  • Run npm install command
  • Start coding

NOTE: Make code adjustments only inside dev folder. Code inside dev folder will be built into src folder.

How to deploy

  • While inside functions/is-odd-or-even path, run nom run build command after you made your desired code changes
  • Go back to the root folder and run appwrite deploy function command. Follow the steps to deploy your function.
  • If needed, refer back to Manual Setup section

How to use

Routes

  • GET - / - Shows a static generator template
  • post - /:
    • Checks if value is a number, and if it is odd or even
    • Allows POST method only
    • Must have 'Content-Type': 'application/json' header
    • Allowed payload example:
  JSON.stringify({
    number: NUMBER VALUE,
  })

Refer to the template to see how it is used in the simple frontend.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published