Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 1.85 KB

README.md

File metadata and controls

51 lines (39 loc) · 1.85 KB

WEB4 OASIS API React Component Library

This is the WEB4 OASIS React UI Components Library that can be used to pick n mix into other React sites who wish to integrate into the WEB4 OASIS API. It is also the main OASIS Portal site and example site of how to build a UI on the WEB4 OASIS API.

This project was bootstrapped with Create React App.

Project Structure

├── react-app 
│   ├── public
│   │   └── index.html
│   ├── src
|   |   ├── assets
|   |   |   ├── images
|   |   |   ├── scss
|   |   ├── components 
|   |   |   ├── common
|   |   |   |   ├── sidebar
|   |   |   ├── popups
│   │   └── index.js

All of the files are stored in react-app folder.

  • index.html is the main html file
  • assets folder contains all assets files for each component like images and css/scss files.
  • components folder contains different components used in the app.
  • components/common folder contains different components tha are common like sidebar, navbar etc.
  • components/popups folder contains different popup components.
  • index.js is the main javaScript file needed for the react-app.

CSS Syntax rules

Please follow these rules so that the other CSS classes does not gets messed up.

For example if you create a component called Login.js It's outer most tag element should have a class of login and the child elements of login should have a class name started with login-

The CSS file should be named Login.css and should be stored under the CSS folder.

How to run the app

First make sure you are in the react-app folder. Then run this command

npm i

This will install all the third-part components used in the project

After this run the following command to open the project in dev mode

npm start