This project uses a combination of firebase, react and redux to deliver 10 random stories from the hacker news topstories feed.
Although it uses a node service it uses this only to deliver static assets.
Firebase presents us with the opportunity to deliver the multiple requests we need over a websocket and makes multiple data requests on the client a much more viable proposition.
A production build is included so that you should be able to see a working page. The file build/public/index.html serves as the entry point of the app. Some form of static file server may be needed to run the app (see node points below)
To use the node service to statically serve this app do the following in the root of the project via terminal
npm i
npm run build
npm run start:node
You should then be able to see the app in http://localhost:3000
Note - due to time constraints I've only managed to test this in Firefox and Chrome.
the set up of this project is build to run on OS X/Linux - some changes might be needed to run on Windows.
Entry points for code are as follows
- js - src/public/bundles/main.js
- css - src/public/bundles/main.scss
- html - src/public/index.marko (generated using index.html.js)
To bring in dependencies run the following in the root of the project..
npm i
See the scripts section of the package.json for a fuller outline..
- npm run start:node - runs the page in a server http://localhost:3000 (requires npm run build first!)
- npm run lint - runs js and json linting tasks
- npm test - runs javascript tests (tests currently exist on a branch)
- npm run compile - outputs static files for css, js, and other static assets
- npm run build - lints, tests, amd compiles the site
- npm run watch - sets up watch tasks to help speed up development
- npm run release - bump the version number and create a release on github
npm run build
npm run start:node
NODE_ENV=production npm run build
NODE_ENV=production npm run start:node
Note: there are only curently a small number of tests for this project. see src > node > config