UXID

User Experience focused Identifiers

Report Bug / Request Feature

Table of Contents

• About the Project
• Getting Started
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Alternatives
• Acknowledgements

About The Project

UXIDs are identifiers which:

• describe the resource (to help in debugging and investigation)
• work well with copy and paste (double clicking should select the entire ID)
• can be shortened for low cardinality resources
• are very unlikely to collide
• are secure against enumeration attacks
• can be generated by application code (not tied to the datastore)
• are K-sortable (lexicographically sortable by time - works well with datastore indexing)
• do not require any coordination (human or automated) at startup, or generation

Getting Started

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

Installation

1. Clone and cd into the repo

git clone https://github.com/riddler/uxid.git
cd uxid

2. Install dependencies and setup the development environment

./bin/setup

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be 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 'Adds some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

See the Contribution Guidelines for more information

License

Distributed under the MIT License. See LICENSE for more information.

Contact

JohnnyT - @johnny_t

Project Link: https://github.com/riddler/uxid

Alternatives

• ULID Universally Unique Lexicographically Sortable Identifier.

Acknowledgements

• Best README Template
• Top Ten Reasons Why I Won't Use Your Open Source Project