Skip to content

A collection of API data that helps users find activities that a local person would do

License

Notifications You must be signed in to change notification settings

sarahannnicholson/Local-City-Events

Repository files navigation

Local City Events

My motivation for this project stemmed from trying to find activities while on vacation. I wanted to experience the city as the local people would, and not necessarily like a tourist. This web application utilizes a variety of social media APIs to provide recommendations to the user.
A user will begin by providing a city name and the application will generate the latest Instagram posts, Foursquare recommendations, and other social media information for that location. The idea is for users to get recommendations to experience a city like the locals.

Acknowledgement

I used the react-redux-starter-kit to get started with this project. The repo can be found here

Requirements

  • node ^4.5.0
  • npm ^3.0.0

Install from source

First, clone the project:

$ git clone https://github.com/sarahannnicholson/Local-City-Events.git <my-project-name>
$ cd <my-project-name>

Then install dependencies and check to see it works

$ npm install                   # Install project dependencies
$ npm start                     # Compile and launch

If everything works, you should see the following:

While developing, you will probably rely mostly on npm start; however, there are additional scripts at your disposal:

npm run <script> Description
start Serves your app at localhost:3000. HMR will be enabled in development.
compile Compiles the application to disk (~/dist by default).
dev Same as npm start, but enables nodemon for the server as well.
test Runs unit tests with Karma and generates a coverage report.
test:dev Runs Karma and watches for changes to re-run tests; does not generate coverage reports.
deploy Runs linter, tests, and then, on success, compiles your application to disk.
deploy:dev Same as deploy but overrides NODE_ENV to "development".
deploy:prod Same as deploy but overrides NODE_ENV to "production".
lint Lint all .js files.
lint:fix Lint and fix all .js files. Read more on this.

About

A collection of API data that helps users find activities that a local person would do

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published