Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 3.23 KB

README.md

File metadata and controls

70 lines (48 loc) · 3.23 KB


Stormtwoopers

Stormtwoopers is a mobile app that allows you to easily sort your Twitter subscriptions by swiping right or left.

Installation

Requirements

Setup

  1. Clone the repository
  2. Install dependencies with npm install
  3. Create a Twitter Developer Account and create a new app (see below for more details)
  4. Create a /src/shared/config.ts and fill it (see /src/shared/config.ts.example for an example)
  5. Remove the owner field from the app.config.js file

Setting up the Twitter Developer Account

Once you have created a Twitter Developer Account, you will need to create a new app named "Stormtwoopers".

Note: The app should have access to the Twitter API v2.

Once you have created the app, you will need to configure the app to allow for user authentication. Here are the fields you will need to fill out:

Field Value
App permissions Read and write
Request email from users Yes
Type of app Native App
Callback URI / Redirect URI https://auth.expo.io/@<your-username>/stormtwoopers
Website URL https://github.com/arthur-fontaine/stormtwoopers
Terms of service https://github.com/arthur-fontaine/stormtwoopers/blob/main/TERMS_OF_SERVICE.md
Privacy policy https://github.com/arthur-fontaine/stormtwoopers/blob/main/PRIVACY_POLICY.md

Usage

Development

  1. Run npm start to start the development server
  2. Scan the QR code with the Expo Go app on your mobile device (iOS or Android)

Contributing

Contributions are welcome! Open an issue, submit a pull request, or reach out to me on Twitter.

License

MIT