mirror of
https://github.com/christianselig/apollo-backend
synced 2024-11-21 19:37:41 +00:00
Update README.md
This commit is contained in:
parent
b992d23c03
commit
ab04b220a4
1 changed files with 3 additions and 12 deletions
15
README.md
15
README.md
|
@ -1,14 +1,5 @@
|
||||||
# Apollo API
|
# Apollo Server Backend
|
||||||
|
|
||||||
## Getting started
|
This repository holds Apollo's code for its server backend, which checks for user notifications and allows users to create subreddit watchers. It is archived as it will no longer be used/updated after June 30th, 2023 per Reddit's decisions in regards to the Reddit API. https://www.reddit.com/r/apolloapp/comments/144f6xm/apollo_will_close_down_on_june_30th_reddits/
|
||||||
|
|
||||||
```sh
|
The goal of making the code for this repo available is to show that despite statements otherwise by Reddit administrators, Apollo does not scrape anything and users purely authenticated Reddit API requests, and does a great deal of work to ensure the Reddit API rate limits are respected.
|
||||||
$ script/bootstrap
|
|
||||||
$ cp .env.example .env
|
|
||||||
```
|
|
||||||
|
|
||||||
## Running the server
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ script/server
|
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in a new issue