hashbang / userdb

Documentation, schema, and container for our PostgreSQL user database.

#! User Database

http://github.com/hashbang/userdb

About

This repo contains the schema, design and requirements for our PostgreSQL-based user database.

Requirements

• PostgreSQL 9.4+

Installation

This will setup userdb as the userdb database on a local PostgreSQL.

make install

Development

Drops you into a fresh PostgreSQL shell with latest schema:

make develop

Testing

make test

Contribution

Please consider the following when submitting contributions:

• Observe the Design Requirements.
• Update the Design Documentation whenever designing new features or modifying their implementation.
• Follow the SQL Style Guide.
• Use Pull Requests for all changes.
• Pull Requests are only merged when all tests pass when merged with master. This is the “not rocket science” rule of software.
• When designing new features, add tests for them right away.

Feel free to reach out to us with ideas or to get help contributing. We are totally happy with something taking longer to do, if you learn something in the process. It is the reason #! exists.

Notes

Questions/Comments?

Please learn and reach out to us via the following:

• IRC: ircs://irc.hashbang.sh:6697/#!
• E-Mail: [e-mail]
• Issue Tracker: https://github.com/hashbang/hashbang/issues
• Documentation: https://github.com/hashbang/hashbang
• Shell Services: https://hashbang.sh