Recursive Todo App

A simple Todo application built with Remix and Appwrite, supporting nested tasks and user authentication.

Features

• User signup and authentication via Appwrite
• Recursive todo list (tasks and sub-tasks)
  • Users can add new to-do items by pressing "Add" button.
  • Users can add sub-tasks to any existing item.
  • Users can mark items as complete by checking the checkbox next to the item.
  • Users can delete items by pressing the "Delete" button.
• Client-side form validation for signup form (Bonus Task)
• Styled pages with colored theme

Setup

1. Clone the Repository

git clone https://github.com/your-username/recursive-todo-app.git
cd recursive-todo-app

Plan for a CI/CD pipeline regarding this project

1.Install Dependencies:

Install dependencies using: npm install

-Ensures all packages required to build and run the app are available.

Appwrite Project Setup

This project uses Appwrite for backend services.

-Make sure Appwrite CLI is installed.
-The project is already linked via appwrite.config.json.

Working with the Appwrite Project Locally

Place the appwrite.config.json file in the root of the project.

To pull all resources (databases, functions, etc.) from the linked Appwrite project:

appwrite pull

This will create the necessary local files for databases, functions, and other resources defined in the cloud project.

Environment Variables

Create a .env file in the project root and add:

APPWRITE_ENDPOINT=your-appwrite-endpoint
APPWRITE_PROJECT_ID=your-project-id

Start the development server
npx remix dev

Open your browser at http://localhost:3000 to see the app.

Optional

To push local changes back to Appwrite:

appwrite push

To view linked project info:

appwrite info

2.Linting & Formatting:

Run eslint or prettier to enforce consistent code style and catch common errors early. Example: npm run lint.

3.Unit & Integration Tests:

Execute tests using a framework like Jest or Vitest. Example: npm run test ensures core functionality like adding, deleting, and marking todos works as expected.

4.Build:

Compile and bundle the Remix application. npm run build

This step ensures the application is production-ready.

5.Deploy:

• Push the repository to GitHub
• Connect the repository to a CI/CD platform like GitHub Actions
• Automatically build and deploy the app on push to the main branch

Recommended Tools:

1. GitHub Actions : for seamless integration with GitHub repositories.

• Key Features:
  GitHub Actions is tightly integrated with GitHub repositories which makes it easy to set up and manage CI/CD pipelines. This integration simplifies the workflow and improves collaboration among team members.

• Pre-built Actions
  GitHub Actions provides a marketplace of pre-built actions that can be used to extend and customize the pipeline.

• Pull Request Automation GitHub Actions can be used to automate various tasks related to pull requests, such as running tests, checking code quality, and providing code feedback etc.

2. Docker : for consistent environment builds across development, testing, and production.

• Using Docker to run the CI/CD pipeline jobs.
• The built Docker image can be deployed to production in a subsequent job.
• Docker improves CI/CD pipelines by providing a consistent environment throughout the development lifecycle. Containers ensure that applications run the same in development, testing, and production environments.