omarnyte/todo-app

Todo App

Local Development

This single-page React web app fetches a mock To Do list. It allows a user to update the completion status of the To Do list items. The app is deployed to https://my-little-to-do-app.herokuapp.com/.

Requirements

• Node.js
• NPM

Setup

1. Clone the repo

2. Install dependencies

   npm install

3. Start the app on default port 3000

   npm start

Testing

Tests are written using Jest.

• To run tests:

  npm test

CI/CD

This project uses Github Actions for CI/CD. The worfklow will:

• run all tests
• build the app

Contributing

1. Fork and clone the repo.
2. Follow the setup steps outlined above.
3. Make your changes, ensuring that code coverage remains at 100%.
4. Open a pull request documenting your changes. Please ensure that that GitHub Actions workflow succeeds.

Deployment

• Production: https://my-little-to-do-app.herokuapp.com/

This repo's main branch automatically deploys to Heroku after the GitHub Actions workflow succeeds.