astrophel

Astrophel Js

Made with create-react-library

Astrophel js is an open source framework that built on top of React Js, one of React Js variant that act as 3D Web development framework to create AR/VR, Game, PWA/TWA on the Web that uses Recoil Js and Aframe Js as the core dependancies.

Contribution is welcome.

Install

npm install --save astrophel

CLI

Using Astrophel CLI will automatically install this

$ npm install -g astrophel-cli
$ astrophel create

Usage

import React, { Component } from 'react'

import MyComponent from 'astrophel'
import 'astrophel/dist/index.css'

class Example extends Component {
  render() {
    return <MyComponent />
  }
}

---

Scene State Management

import { GlobalStates } from "astrophel";

// to get data
const { data } = GlobalStates(‘data’, {} );

// to set data
const { setData } = GlobalStates(‘data’, {} );
setData(someData);

where

const { <keyStateName> } = GlobalStates(<keyStateName>, <keyDefaultValue> );

---

Requirements

For development, you will only need Node.js and a node global package installed in your environement.

Node

• Node installation on Windows

  Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

• Node installation on Ubuntu

  You can install nodejs and npm easily with apt install, just run the following commands.

  $ sudo apt install nodejs
  $ sudo apt install npm
  

• Other Operating Systems

  You can find more information about the installation on the official Node.js website and the official NPM website.

If the installation was successful, you should be able to run the following command.

$ node --version
v8.11.3

$ npm --version
6.1.0

If you need to update npm, you can make it using npm! Cool right? After running the following command, just open again the command line and be happy.

$ npm install -g npm

---

License

MIT © retzd-tech