To-do List App

A take-home assignment done by Sean

View Demo at todolistapp.fly.dev

Table of Contents

1. About The Project
2. Features
3. Roadmap
4. Installation
5. Usage
6. Contributing
7. License
8. contact

About The Project

This todo list app is a full stack application using Remix with SQLite and Prisma (SQLite database).

(back to top)

Features

1. Create and delete a TodoPage.

Screen.Recording.2024-12-10.at.16.09.55.mov

2. Create, delete, and complete a Todo

Screen.Recording.2024-12-10.at.16.10.54.mov

3. Each TodoPage is linked to a date. Use the calendar to traverse through the dates.

Screen.Recording.2024-12-10.at.16.05.11.mov

Built With (initialised project with indie-stack)

• Remix (TypeScript)
• SQLite database
• Database ORM with Prisma
• Styling with TailwindCSS
• Component library Shadcn

(back to top)

Roadmap

• Add TodoPage feature
• Add Todos feature
• Search TodoPages based on date
• Write unit tests incrementally during dev
• Use libSQL instead of SQLite and deploy on Turso
• e2e tests with Cypress and integration tests

Getting Started

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/SeansC12/to_do.git

2. Install NPM packages

   npm install

3. Create a .env file and populate it with the below

   DATABASE_URL="file:./data.db?connection_limit=1"
   SESSION_SECRET="21378129378914719" # any secret will work

4. Initialise Prisma and seed the db

   npx remix init
   npm run setup
   npm run dev

(back to top)

Usage

1. Create an account and log in to the application
2. Start creating TodoPages and Todos

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Unlicense License. See LICENSE.txt for more information.

(back to top)

Contact

Sean Chua - https://seanchua.vercel.app/ - sean.ulric.chua@gmail.com