Skip to content
This repository has been archived by the owner on Jun 26, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
christianselig authored Jun 8, 2023
1 parent e35fee4 commit 88a4d4c
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 88a4d4c

Please sign in to comment.