Parallax.js Demo App

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• nvm >= 0.33.11

Installing and setting up the repository

1. Clone the repository from GitHub:

git clone https://github.com/mgoigfer/parallax-js-demo-app.git <project-name> && cd <project-name> && rm -rf .git

2. Install Node.js and npm. The following nvm commands will install the Node.js at .nvmrc:

nvm install && npm install -g npm@6.4.1

3. Install npm dependencies:

npm install

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Built With

This project was bootstrapped with Create React App.

Also, it makes use of these libraries:

• parallax.js: to perform the parallax effect.
• fullpage.js: to perform jumps between scenes.

And these browser events:

• Device Orientation Event: to be able to use the mobile gyroscope.
• Device Motion Event: to be able to use the mobile accelerometer.

Authors

• Mikel Goig - mgoigfer