README.md

Tick

A minimalist to-do list application

Explore Docs . Report Bug · Request Feature

Table of Content

• About The Project
  • Overview
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Features
• Contributing
• Contact
• Acknowledgments

About The Project

Overview

Idea

Tick is an efficient and streamlined task management system with a minimalist UI/UX built using industry-standard tools.

UI Design

Figma file: https://www.figma.com/design/SxbR2AyfbCF8SzcITxkXX2/Tick?node-id=14-91&t=N5AaZ9jSvlQ5kMcN-1

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

• Node.js
• Node Package Manager (NPM)

Installation

1. Clone the repo

   git clone https://github.com/chinweibegbu/tick-frontend.git

2. Install NPM packages

   npm install

3. Start local environment

   npm run dev

(back to top)

Contributing

If you have a suggestion that would make this better, follow these steps:

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

Alternatively, you can open an Issue.

(back to top)

Features

General Features

• Landing Page
• Sign Up Page
  • Create user
    • userName
    • firstName
    • lastName
    • password
    • confirmPassword
    • email
    • profilePhoto
• Loading state indicators
  • Loading React component top bar
  • Loading state spinning animations
  • Success state toast notifications
  • Failure state toast notifications

Ticker Features

• Sign In Page
  • Authenticate user
  • Send reset password email
  • Reset password
• Dashboard
  • View all user's tasks
    • Filter completed tasks
    • Filter uncompleted tasks
  • Add task
  • Duplicate task
  • Edit task
  • Mark task as completed (or not)
  • Delete task
  • Re-order tasks
  • Logout user

Admin Features

• Sign In Page
  • Authenticate user
  • Forgot password
• Dashboard
  • View all tasks
  • View all users
  • Edit user
  • Delete user
  • Disable user
  • Logout user

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Chinwe Ibegbu - chinwe.ibegbu@gmail.com

Project Link: https://github.com/chinweibegbu/tick-frontend/

(back to top)

Acknowledgments

• README.md template by Drew Othneil
• Badges by shields.io
• Awesome Badges by Vedant Chainani
• Markdown Badges by Ileriayo Adebiyi

(back to top)