mirror of
https://github.com/reddit-archive/reddit.git
synced 2026-04-05 03:00:15 -04:00
32 lines
1.7 KiB
Markdown
32 lines
1.7 KiB
Markdown
# reddit
|
|
|
|
<img src="https://secure.gravatar.com/avatar/c638493729c2f009988c9e5bd9b5e116?s=200" align="right">
|
|
|
|
Greetings!
|
|
|
|
This is the primary codebase that powers [reddit.com](http://www.reddit.com).
|
|
|
|
For notices about major changes and general discussion of reddit development, subscribe to the [/r/redditdev](http://www.reddit.com/r/redditdev) and [/r/changelog](http://www.reddit.com/r/changelog) subreddits.
|
|
|
|
You can also chat with us via IRC in [#reddit-dev on FreeNode](http://webchat.freenode.net/?channels=reddit-dev).
|
|
|
|
---
|
|
|
|
### Quickstart
|
|
|
|
To set up your own instance of reddit to develop with, we have a handy [install script for Ubuntu](https://github.com/reddit/reddit/wiki/reddit-install-script-for-Ubuntu) that will automatically install and configure most of the stack.
|
|
|
|
Alternatively, refer to our [Install Guide](https://github.com/reddit/reddit/wiki/Install-guide) for instructions on setting up reddit from scratch. Many frequently asked questions regarding local reddit installs are covered in our [FAQ](https://github.com/reddit/reddit/wiki/FAQ).
|
|
|
|
### APIs
|
|
|
|
To learn more about reddit's API, check out our [automated API documentation](http://www.reddit.com/dev/api) and the [API wiki page](https://github.com/reddit/reddit/wiki/API). Please use a unique User-Agent string and take care to abide by our [API rules](https://github.com/reddit/reddit/wiki/API#wiki-rules).
|
|
|
|
Happy hacking!
|
|
|
|
### Issues and Contribution Guidelines
|
|
|
|
Thanks for wanting to help make reddit better! First things first, though: **github issues is only for _confirmed_, active bugs**. Please submit ideas to [/r/ideasfortheadmins](https://www.reddit.com/r/ideasfortheadmins/).
|
|
|
|
Please read more on contributions in [CONTRIBUTING.md](CONTRIBUTING.md).
|