REST API for the World Texting Foundation, also known as WTF.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

Your system needs a fairly recent version of Node.

Installing

If that's all good, then install all necessary dependencies inside the target folder using:

npm install

Then run the development server:

npm run dev

developement server runs on port 8080

Available enpoints

• GET /acronym?from=50&limit=10&search=:search
• GET /acronym/:acronym
• GET /random/:count?
• POST /acronym
• PUT /acronym/:acronym
• DELETE /acronym/:acronym:

Important: Each request needs to have an Authorization header to identify yourself. For example:

• Using fetch:

fetch(url, { headers: { 'Authorization': 'whatever-you-want' }})

Built with

• Express
• Sequelize
• Sqlite (development enviroment)
• Babel
• PostgresSQL (production enviroment)

Author

• Juan Marco

License

See LICENSE.md

Bugs

PR's welcome! Open a PR and we'll take it from there.