Skip to content

horiaradu/twitter-challenge

Repository files navigation

Twitter Challenge

A sample app which retrieves tweets and displays them.

For backend, I created a REST API with loopback. The API documnetation can be found under /explorer/#. The authentication is done with access tokens.

In order to be able to access the twitter API, you must create an app on twitter in order to obtain credentials.

For user registration and password recovery, it uses emails and thus you need an smtp server configured. For exmaple, you can use gmail.

The frontend, is created with React and Redux, for the styling I used bootstrap and font awesome.

Get Started

  • Clone this repository
$ git clone git@github.com:horiaradu/twitter-challenge.git
  • Install dependencies specified in package.json
$ npm install
  • Start the server (default port is set to 3000)
$ npm start

Required environment variables

# twitter API credentials
TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
# gmail credentials for sending out emails
GMAIL_AUTH_USER=
GMAIL_AUTH_PASSWORD=
# dummy username and password
DUMMY_USER=
DUMMY_PASSWORD=

Missing features

The email templates are not styled and the email confirmation and sign up are not created (however, they were not in scope).

Since it was supposed to use a dummy user, I didn't go for a database, but went for an in-memory storage solution. At boot time a sample user configured in the environment variables. It's very easy to switch and use a database in the future.

License

MIT

Copyright

Copyright (C) 2015 Tony Ngan, released under the MIT License.

About

Sample app which retrieves tweets and displays them

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors