Update README.md

This commit is contained in:
Christian Selig 2023-06-26 11:45:18 -03:00 committed by GitHub
parent b992d23c03
commit ab04b220a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 12 deletions

View File

@ -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
$ script/bootstrap
$ cp .env.example .env
```
## Running the server
```sh
$ script/server
```
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.