reactonite 0.1.0

Reactonite

A transpiler to convert HTML to React code and PWAs ✨
Explore the Docs »
Table of Contents . Report Bug . View Project

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Development Setup
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

Reactonite is a wrapper for React which allows one to write vanilla html code and convert it to a react code and hence building a PWA, SPA.

Here's the key features added to Reactonite:

• Transpile HTML code to React website
• Create PWAs and React applications as quickly as possible
• Act as a wrapper to NPM
• Allow importing of already created HTML file components
• Hot Reloading
• Support custom scss, js, css etc. :smile:

Built With

This project was bootstrapped with Create React App

Getting Started

To get this repo up and running on your local machine follow these simple steps.

Prerequisites

Here's a list of things you'll need to have prior to installing the software.

• Python
• NPM
• NodeJs
• Any modern web browser

Installation

1. Use pip to install Reactonite

$ pip install reactonite

Development Setup

1. Setup virtual environment?

$ virtualenv venv

Not necessary but recommended to keep your environment clean. Dont forget to activate it.

2. Clone the repository to local machine.

$ git clone https://github.com/SDOS2020/Team_3_Reactonite.git

3. Install the package either using pip or python setup tools

$ python setup.py install
# Use `develop` instead of `install` to get an editable build

# Alternatively run
$ pip install .

3. You are good to go... 🎉

Usage

Once installed refer to the documentation for the set of commands available with Reactonite cli or you can begin by typing reactonite --help which opens the help page for reactonite command line tool.

$ reactonite --help
Usage: reactonite [OPTIONS] COMMAND [ARGS]...

  Entry point for Reactonite cli.

Options:
  --help  Show this message and exit.

Commands:
  ...

Roadmap

See the open issues for a list of proposed features (and known issues). You can also track where the project is going in further releases just visit the projects tab.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. For complete contributing guide please read our code of conduct.

License

MIT License. See LICENSE for more information once complete.

Contact

• Amogh Gulati - amogh17019@iiitd.ac.in
• Aniket Pradhan - aniket17133@iiitd.ac.in
• Avi Garg - avi17223@iiitd.ac.in
• Chirag Jain - chirag17041@iiitd.ac.in

Project Link: https://github.com/SDOS2020/Team_3_Reactonite