Skip to content
No description, website, or topics provided.
JavaScript Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.dockerignore
.editorconfig
.gitignore
Dockerfile
README.md
package-lock.json
package.json

README.md

Node.js and Express To-Do API Secured with Auth0

To learn how to develop APIs similar to this one, check this article: https://auth0.com/blog/node-js-and-express-tutorial-building-and-securing-restful-apis/

Running

To run this sample, you can either use Docker to decouple the server from the host machine, or you can use Node.js and NPM. Fell free to choose whatever suits you better.

Running with NPM and Node.js

First, you will need to clone this repo in the host machine. After that, on a terminal, run the following commands:

# move into the project root
cd to-do-apis

# install its dependencies
npm install

# run the application
npm start

Running with Docker

There is an image on Docker Hub that you can use. To run it, issue the following command:

docker run -p 3001:3001 -d auth0blog/to-dos-api-express

This will run the project on a Docker container and expose the API on port 3001 on the host. Feel free to adjust these setting to your needs.

Consuming the API

This is a HTTP API (or a RESTful API, if you will). As such, to consume this API you will need to issue HTTP requests from some client. For example, you can use Postman, Insomnia, curl, etc. The following commands show how use the latter:

# request all to-do items
curl localhost:3001

# insert a new to-do
curl -X POST -H 'Content-Type: application/json' -d '{
  "message": "Buy some yummy pizza!"
}' http://localhost:3001/

Updating the Docker Image

# build the image
docker build -t auth0blog/to-dos-api-express .

# push the new version
docker push auth0blog/to-dos-api-express
You can’t perform that action at this time.