Skip to content

Commit

Permalink
docs: update roadmap
Browse files Browse the repository at this point in the history
  • Loading branch information
hywax committed Aug 5, 2024
1 parent 89aa092 commit e2b4644
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,45 @@
# Roadmap

This file provides an overview of the direction this project is heading. The roadmap is organized in steps that focus on a specific theme.
This file provides an overview of the direction in which the project is heading. The roadmap is organized into phases that focus on a specific topic.
The result of all the work is a complete application. In which short links can be created.

## Auth

Auth is the first step in the roadmap. It includes all the features related to authentication and authorization.

- [x] Login page
- [x] Register page
- [ ] Forgot password page
- [ ] Forgot password page (After MVP)

## Account

This section describes the functions related to user account management.
This section describes the functions related to managing your account.

- [ ] Update account
- [ ] Change password
- [ ] Delete account
- [x] Update account
- [x] Change password
- [x] Delete account

## Dashboard

The dashboard is the main page of the application. It provides an overview of the user's data and allows them to manage their projects.

### Projects

- [ ] CRUD operations
- [ ] Share project
- [ ] Transfer project
- [ ] Tags
- [ ] CRUD operations
- [ ] API keys
Projects are the main entities in the application. They represent a collection of short links.

- [ ] Share project (After MVP)
- [ ] Transfer project (After MVP)
- [ ] Tags (After MVP)
- [ ] API keys (After MVP)

### Links

- [ ] CRUD operations
- [ ] Analytics
Links are the main entities in the application. They represent a short link that redirects to a specific URL.

- [ ] Analytics (After MVP)
- [ ] Overview (total clicks, views, etc.)
- [ ] Export data
- [ ] Advanced settings
- [ ] Advanced settings (After MVP)
- [ ] QR code
- [ ] Expiration management (time, clicks)
- [ ] Password protection
Expand All @@ -49,6 +51,6 @@ The dashboard is the main page of the application. It provides an overview of th

The documentation is a crucial part of the project. It helps users understand how to use the application and how to integrate it into their projects.

- [ ] API
- [ ] API (After MVP)
- [ ] User guide
- [ ] Developer guide

0 comments on commit e2b4644

Please sign in to comment.