Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/keellyp/oculus-rift

Redesign of the Oculus Rift website Β πŸ•Ά
https://github.com/keellyp/oculus-rift

axios gulp intersection-observer oculus-rift rellax scrollreveal yarn

Last synced: 3 days ago
JSON representation

Redesign of the Oculus Rift website Β πŸ•Ά

Awesome Lists containing this project

README

        

# Oculus Rift
[![Node](https://img.shields.io/badge/Node-%3E%3D8.9.1-brightgreen.svg?style=flat-square)]()
[![Gulp](https://img.shields.io/badge/Gulp%20-%3E%3D3.9.1-blue.svg?style=flat-square)]()
[![Yarn](https://img.shields.io/badge/yarn-%3E%3D1.3.2-ff69b4.svg?style=flat-square)]()

![Oculus Rift](screenshot.png "Oculus Rift")

This is a school project based on the Oculus Rift website. I don't own any rights.

[See the demo](https://oculus-rift.netlify.com/)

[![Netlify](https://www.netlify.com/img/global/badges/netlify-color-bg.svg)]()

## How to πŸŽ‰

### Installation πŸ“¦
First, do not forget to install [Node.js](https://nodejs.org/en/) and [Yarn](https://yarnpkg.com/en/docs/install).
After downloaded the repository, install the node_modules with :

```
yarn install
```

### Running the app πŸš€
To run the app, run this command in your terminal :
```
yarn run dev
```

Then browser-sync should start and you should be able to see the app.

### Build it πŸ‘·
To build it, run this command in your terminal :
```
yarn run build
```

## Precisions πŸ“
- I used the [BEM](http://getbem.com/naming/) naming class convention.
- For the CSS, I added [CSSComb](https://github.com/csscomb/csscomb.js) to format and sort our code.
- For the Javascript, I used [ESLint](https://github.com/eslint/eslint) and code in ES6.
- I liked to use [gitmoji](https://github.com/carloscuesta/gitmoji/) when I commited to identify quickly the purpose of the commit
- Everytime I could, I followed the rules of [FrontEndChecklist](https://frontendchecklist.io/)

## Other πŸ”Ž

### Thanks πŸ‘₯

To [LΓ©na Mari](https://www.behance.net/lenammari) and [Valentin Martinez](https://www.behance.net/valentinma2045) for the design.

To [Samuel Mormin](https://github.com/samuelmormin) for the help.

### Licence πŸ“„
This repository is under MIT Licence.