Giter VIP home page Giter VIP logo

node-fetch-app's Introduction

Build Status

Node fetch app documentation

A NodeJS built application with express, express handelbars, node-fetch, bootstrap carousel for fetching a fake REST API into a JSON Object, then displaying it in a responsive carousel. Live deployed demo here.

Reponsitivity test result: Here.

- This guide is dissected into two sections:

  • How to install/run the app
  • File structure

How to install/run the app?

Installing nodejs and npm
  1. The app is built on Node.jS, so to be able to run it you must have Node.JS and NPM. If you already have it on your system proceed to step(3).
  2. Visit Node.JS, then download your OS installer and run it.
  3. Now you should have both NodeJS and NPM installed on your system.
elrakabawi$ node --version && npm --version
Installing and running our app
  1. clone the project: git clone https://github.com/ElRakabawi/node-fetch-app.git Then, access the directory with cd node-fetch-app
  2. Run npm install in your command, then run npm start. This will run this commands:
elrakabawi$ npm start
> [email protected] start Desktop/node-fetch-app
> node index.js

listening at localhost:3000

Now, it's all up and running. Open your browser and visit localhost:3000. You should expect something like the online delpoyed heroku app here https://node-fetch-app.herokuapp.com/.

File and folder structure

node-fetch-app
│
│─── README.md
│─── package.json
│─── index.js      
│               
└───public
│   └─── stylesheet
|   |     |
|   |     └─── style.css
│   │   
|   └─── js
|        |
|        └─── core-interface.js 
│   
|───views
|    │───home.handelbars
|    │
|    └─── layouts                 
|           └───main.handelbars  
|
└─── node_modules   

index.js: Where fetching happens using node-fetch, JSON strigified then parsed and server is created with express.
core-interface.js: Enhancer for behaviour and look of the bootstrap carousel.
home.handlebars: Contains home view, handled by express-handelbars to generate HTML sections from parsed JSON object.
main.handlebars: Contains main HTML Layout.

Waving goes to Motoon.org, I enjoyed the task.

node-fetch-app's People

Contributors

elrakabawi avatar

Watchers

 avatar  avatar

Forkers

pradipyadav26

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.