Skip to content

nullabs/toy-todo-server

Repository files navigation

toy-todo-server

Node.js GitHub Actions Workflow Status License

A minimalistic toy API server for managing todos, built with Node.js and Express. This server supports basic CRUD operations for todos, logging, environment configuration, and health checks.

🛠️ Dependencies

🚀 How to Start the App

  1. Ensure prerequisites are installed:

    • Install Docker and ensure it is running.
    • Install Make (pre-installed on most Linux/macOS systems).
  2. Start the app: Run the following command to build and start the app in a Docker container:

    make
  3. Access the app: Once the app is running, open your browser and navigate to:

    http://localhost:3000
    

🧪 Testing

To test the API, you can use Hurl or any API client like Postman.

Populate Todos

You can use the populate.hurl file to populate the server with sample todos. This file contains predefined HTTP requests to create sample data.

Run the following command to execute populate.hurl:

hurl populate.hurl

Run Tests

To test the API endpoints, use the test.hurl file:

hurl --test test.hurl

Ensure the server is running before executing these commands.

About

A toy todo server witten in Node.js and Express

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •