9andresc / world-texting-foundation

A simple Node.js server that provides an API for WTF (World Texting Foundation)

World Texting Foundation API

A simple Node.js server that provides an API for WTF (World Texting Foundation)

Installation

1. Install dependencies

$ npm i

2. Run DB migrations

$ npm run dbm:run

3. Run DB seeds

$ npm run dbs:run

4. Create .env file in root with this content

JWT_SECRET=
PORT=3000

5. Run script to generate JWT secret

$ npm run spt:secret

6. Fill JWT_SECRET value

JWT_SECRET=<value>
PORT=3000

Usage

• To start the API server run

$ npm start

• To run the test suite

$ npm test

• There's a Postman collection ready to be imported inside /src/docs
• If you want to use the guarded endpoints PUT and DELETE /acronym/:acronym, generate a token running

$ npm run spt:token

Acknowledgments

• Document API using Swagger to have a more universal way to test the endpoints
• Use Docker to containerize API, and maybe even use a more robust database like PostgreSQL in conjunction