Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/neverstew/alexorpj

The biggest Reply All question of all time.
https://github.com/neverstew/alexorpj

Last synced: about 2 months ago
JSON representation

The biggest Reply All question of all time.

Awesome Lists containing this project

README

        

Alex Or PJ?
===========

This is the application that hosts the Alex or PJ functionality on the web. This
README documents how to get things up and running.

# Development
In order to get the application to run, there are a couple of steps.

## Virtual env
As per usual, you need to create a virtual environment and install dependencies. I'm
not going to cover that here.

## Env Vars
The app needs a number of env vars to be passed to it in order to function. It's set up
to grab these from a `.env` file in the root directory. Create this file and add entries
to it for

```
SECRET_KEY=
TWITTER_CONSUMER_TOKEN= #from the twitter app
TWITTER_CONSUMER_SECRET= #from the twitter app
```

## Running the app
To run the application, execute the following command in the root directory.

```
gunicorn --pythonpath src app:app --reload
```

## Testing
Run the test suite with
```
pytest src
```