twitter-api-client-server

NodeJS server that uses FeedHive/twitter-api-client to interact with the Twitter API.

Table of content

• Features
• Requirements
• Getting Started
• Docker
• Help
• Contribute
• License

---

Features

• NodeJS server with watch mode support (thanks to nodemon)
• Two example routes using the Twitter API client
• Full Docker support
• ESLint and prettier setup
• Jest & supertest setup for tests
• Fully typed!
• with GitHub Action Continuous integration workflow

Requirements

You need to apply for Twitter's Developers programm and create an application. You will need to obtain the secrets and tokens to interact with the API.

Getting Started

# Step 1
# --> install dependencies
yarn

# Step 2
# --> prepare the .env file
yarn copyfiles

# Step 3
# --> open the .env-file and add the missing information

# Step 4
# --> build the app the first time
yarn build

# Step 5
# --> start the app
yarn start

Example Links

• http://localhost:3000/: home route
• http://localhost:3000/api/accountsAndUsers/usersSearch/natterstefan: Provides a simple, relevance-based search interface to public user accounts on Twitter.
• http://localhost:3000/api/tweets/statusesUserTimeline/natterstefan: Returns a collection of the most recent Tweets posted by the user indicated by the screen_name

Docker

This node application is dockerized and can be used in a docker environment.

How to run the Docker Image

# this will first build and then start the docker image
docker-compose up --build

How to build the Docker Image

docker-compose build

Help

• Reach out on Twitter
• Open an issue on GitHub

Troubleshooting

• The app does not start? Make sure you run yarn build before the very first time you start the app.

Contribute

Issues

In the case of a bug report, bugfix or a suggestions, please feel very free to open an issue.

Pull request

Pull requests are always welcome!

Misc

• https://github.com/microsoft/TypeScript-Node-Starter
• https://github.com/w3tecch/express-typescript-boilerplate
• https://github.com/gothinkster/node-express-realworld-example-app

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Stefan Natter 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!

Licence

Apache 2.0