High Level Goals and Requirements

(Copied from [the README](https://github.com/citybound/modstore/blob/08dbbaec332e0903878c5000711da1c2f01ffbfd/README.md))

# The Citybound Modstore

A webapp to discover, rate and publish mods for Citybound.

## Goals

- CRUD for Mods
- Augmented: Submit, publish, unpublish, update, and delete mods
- Browse Mods
- Mod API
- User Management
- Moderation/Curation of Mods
- Security

Others TBD?

## Tooling

- Backend
- node.js? Express?
- DB? (See citybound/modstore#3)
- Frontend:
- React?

## Functional Requirements

### CRUD for Mods

CRUD operations performed by users to submit, publish, unpublish, update, and delete mods.

- Only authenticated users may submit mods
- Mod data and metadata

#### Questions

- What is mod data and metadata? (See citybound/modstore#3)
- How are mods submitted?
- How are mods updated?
- What kind of version management should the modstore maintain, if at all?
- Should mods be able to be deleted on a whim?

### Browse Mods

- Search for mods by:
- Name
- Keywords
- Author/Creator (Contributors?)
- Popularity
- Date
- Etc?
- Discover mods curated by moderators
- Rate mods

#### Questions

- What kind of rating system should be maintained? (See citybound/modstore#3)

### Mod API

An interface to the modstore's Browsing features.

#### Questions

- How much of the modstore's features will the Game Client make use of?
- Limited to simply Search, Update, and Install?

### User Management

- Registration
- Login/Logout
- Change password/password reset
- Profile?
- Gravatar photo?
- Biography?
- Location?
- Age?

#### Questions

- Login integrations with popular services like Google, Facebook, GitHub, etc?

### Moderation

- Manual review of submitted mods?
- Curate individual and lists of mods
- Promote featured mods
- Manage and respond to report of abuse and policy violations

#### Questions

- Different roles for moderators? (e.g Editor/Curator vs. Maintainer/Abuse Mitigation)
- What are the modstore's policies?
- Terms of Service?
- Abuse Resolution Policy?

### Security

- Mod archive checksums?
- TLS/HTTPS
- Follow [OWASP Recommendations](https://www.owasp.org)

#### Questions

- Assuming malicious intent, what content should be allowed?

Others TBD

## Nonfunctional Requirements

- Reliable availability/uptime
- Terms of Service?
- Privacy Policy?
- Cookie Policy?
- Abuse/Conflict Policy?

Others TBD

## Questions

- What are the main goals of the Modstore?
- What kinds of guarantees does the Modstore make for its clients?
- How should the the name be stylized? `modstore`, `Modstore`, or `ModStore`?
- Is the name final? (Should we spawn a new issue?)
- How will the webapp be required to scale?
- Other requirements?