# Roadmap

## Current Target: MVP

The current goal for Giterated is to reach MVP. MVP is defined by a few key features, which will be outlined. 

### MVP
- Users
  - Authentication
    - [X] Password Authentication
    - [ ] Keypair Authentication
  - Customization
    - [X] User Bio
    - [X] Display Name
    - [ ] Profile Images
- Repositories
  - File Viewer
    - [X] View by Branch
    - [X] View by Commit
    - [X] View commit information
    - [ ] Browse previous commits
    - [ ] Browse tags
    - [X] Browse branches
  - Issues
    - TBD
  - Settings
    - TBD
  - Pull Requests
    - TDB
- Instance
  - Usage Settings
    - [ ] Limit Account Creation
    - [ ] Limit Repository Creation
    - [ ] Set usage limits by size quota
  - Management Tools
    - [ ] Event Log
    - [ ] Event Stream
    - [ ] User Management
    - [ ] Repository Management
- Git
  - HTTPS and SSH support
- Deployment Formats
  - [ ] Single-Binary sqlite database
  - [ ] Single-Binary postgres database
  - [ ] Single Daemon, Internal Git SSH worker, Postgres Database
  - [ ] Single Daemon, External Git SSH worker, Postgres Database
  - [ ] Multi-Daemon, Single Database, Postgres Database
  - [ ] Multi-Daemon, Multi-Database, Single Authentication Provider, Postgres Database

### Security and Reliability testing
- Protocol Fuzzing
  - TBD

### Documentation
- [ ] Intention
- [ ] Architecture
- [ ] Usage (for Users)
- [ ] Usage (for operators)
- [ ] Installation
  - [ ] Installation flow chart / webapp
- [ ] Deployment
  - [ ] Example deployments and docs on giterated.dev's deployment
- [ ] Code Documentation

## Acceptance Criteria
Giterated will be considered to have met the target of MVP when the following conditions are met:

1. **ALL** security tests have passed and their results validated.
2. **ALL** MVP feature critera that falls in to the following categories must be implemented and integration tested:
    - Authentication
    - Git
    - Usage Settings
    - Management Tools
3. **ALL** code that falls into the following categories must be unit tested:
    - Authentication
    - Authorization
    
## Revisions
26th Tuesday September 2023 - [View Revision](https://giterated.dev/ambee/giterated/blob/4322bd3b53faccbfe277b8ae88c3835994e1a3f0/ROADMAP.md)  
11th Wednesday October 2023 - [View Revision](https://giterated.dev/ambee/giterated/blob/259d512e757271917294cdd62de77d2e4e01d286/ROADMAP.md)