Skip to content

Commit 7fd3304

Browse files
avisionxavisionx
authored
Merge pull request #73 from SDOS2020/dev
Create alpha release for reactonite 🎉
2 parents d4d660c + 90d9729 commit 7fd3304

32 files changed

Lines changed: 2486 additions & 20 deletions

‎.github/workflows/python-linter.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# This workflow will installs Python dependencies, and lints the codebase
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3+
4+
name: Python Linter
5+
6+
on:
7+
push:
8+
branches: [beta]
9+
pull_request:
10+
branches: [beta, master]
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
strategy:
16+
matrix:
17+
python-version: [3.6, 3.7, 3.8, 3.9]
18+
steps:
19+
- uses: actions/checkout@v2
20+
- name: Set up Python ${{ matrix.python-version }} 🛎️
21+
uses: actions/setup-python@v2
22+
with:
23+
python-version: ${{ matrix.python-version }}
24+
- name: Install dependencies ✔️
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install flake8 pytest
28+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
29+
- name: Lint with flake8 ✨
30+
run: |
31+
# stop the build if there are Python syntax errors or undefined names
32+
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
33+
# exit-zero treats all errors as warnings.
34+
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=79 --statistics

‎.gitignore‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
131+
# VS Code
132+
.vscode/
133+
134+
# JetBrains
135+
.idea/

‎CONTRIBUTING.md‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Contributing
22

33
When contributing to this repository, please first discuss the change you wish to make via issue,
4-
email, or any other method with the owners of this repository before making a change.
4+
email, or any other method with the owners of this repository before making a change.
55

66
Please note we have a [code of conduct](#), please follow it in all your interactions with the project.
77

88
## Pull Request Process
99

10-
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
10+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
1111
build.
12-
2. Update the README.md with details of changes to the interface, this includes new environment
12+
2. Update the README.md with details of changes to the interface, this includes new environment
1313
variables, exposed ports, useful file locations and container parameters.
1414
3. After creating the pull request, one of the org owners would review the request and if everything
1515
works out, they'll merge the request in due time.
@@ -35,21 +35,21 @@ For JavaScript, we will follow the ESLint styling guidelines.
3535
Examples of behavior that contributes to creating a positive environment
3636
include:
3737

38-
* Using welcoming and inclusive language
39-
* Being respectful of differing viewpoints and experiences
40-
* Gracefully accepting constructive criticism
41-
* Focusing on what is best for the community
42-
* Showing empathy towards other community members
38+
- Using welcoming and inclusive language
39+
- Being respectful of differing viewpoints and experiences
40+
- Gracefully accepting constructive criticism
41+
- Focusing on what is best for the community
42+
- Showing empathy towards other community members
4343

4444
Examples of unacceptable behavior by participants include:
4545

46-
* The use of sexualized language or imagery and unwelcome sexual attention or
47-
advances
48-
* Trolling, insulting/derogatory comments, and personal or political attacks
49-
* Public or private harassment
50-
* Publishing others' private information, such as a physical or electronic
46+
- The use of sexualized language or imagery and unwelcome sexual attention or
47+
advances
48+
- Trolling, insulting/derogatory comments, and personal or political attacks
49+
- Public or private harassment
50+
- Publishing others' private information, such as a physical or electronic
5151
address, without explicit permission
52-
* Other conduct which could reasonably be considered inappropriate in a
52+
- Other conduct which could reasonably be considered inappropriate in a
5353
professional setting
5454

5555
### Our Responsibilities
@@ -76,7 +76,7 @@ further defined and clarified by project maintainers.
7676
### Enforcement
7777

7878
Instances of abusive, harassing, or otherwise unacceptable behavior may be
79-
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
79+
reported by contacting the project team, for contact details [visit](https://github.com/SDOS2020/Team_3_Reactonite/#contact). All
8080
complaints will be reviewed and investigated and will result in a response that
8181
is deemed necessary and appropriate to the circumstances. The project team is
8282
obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -93,4 +93,5 @@ available at [http://contributor-covenant.org/version/1/4][version]
9393

9494
[homepage]: http://contributor-covenant.org
9595
[version]: http://contributor-covenant.org/version/1/4/
96+
9697
[sourced from](https://gist.github.com/PurpleBooth/b24679402957c63ec426)

‎MANIFEST.in‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
recursive-include reactonite/init_src_dir *
2+

‎README.md‎

Lines changed: 141 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,142 @@
1-
# Reactonite
1+
<p align="center">
2+
<img src="https://user-images.githubusercontent.com/32339251/95760847-2265f880-0cc9-11eb-8cd5-ca641cea0771.png" alt="" width="160" />
3+
<h3 align="center">Reactonite</h3>
4+
5+
<p align="center"><img src="https://github.com/SDOS2020/Team_3_Reactonite/workflows/Python%20Linter/badge.svg?branch=beta" />
6+
<a onclick="window.open(this.href,'_blank');return false;" href="https://reactonite.github.io/reactonite/"><img src="https://img.shields.io/website?label=documentation&up_message=up&url=https%3A%2F%2Freactonite.github.io%2Freactonite%2F"/></p></a>
27

3-
1. Amogh Gulati
4-
2. Aniket Pradhan
5-
3. Avi Garg
6-
4. Chirag Jain
8+
<p align="center">
9+
A transpiler to convert HTML to React code and PWAs ✨
10+
</br>
11+
<a href="https://reactonite.github.io/reactonite/"><strong>Explore the Docs »</strong></a>
12+
<br/>
13+
<a href="https://github.com/SDOS2020/Team_3_Reactonite/#table-of-contents">Table of Contents</a> . <a href="https://github.com/SDOS2020/Team_3_Reactonite/issues">Report Bug</a> . <a href="https://github.com/SDOS2020/Team_3_Reactonite/projects">View Project</a>
14+
</p>
15+
</p>
16+
17+
<!-- TABLE OF CONTENTS -->
18+
19+
## Table of Contents
20+
21+
- [Table of Contents](#table-of-contents)
22+
- [About The Project](#about-the-project)
23+
- [Built With](#built-with)
24+
- [Getting Started](#getting-started)
25+
- [Prerequisites](#prerequisites)
26+
- [Installation](#installation)
27+
- [Usage](#usage)
28+
- [Roadmap](#roadmap)
29+
- [Contributing](#contributing)
30+
- [License](#license)
31+
- [Contact](#contact)
32+
33+
<!-- ABOUT THE PROJECT -->
34+
35+
## About The Project
36+
37+
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.
38+
39+
Here's the key features added to Reactonite:
40+
41+
- Transpile HTML code to React website
42+
- Create PWAs and React applications as quickly as possible
43+
- Act as a wrapper to NPM
44+
- Allow importing of already created HTML file components
45+
- Hot Reloading
46+
- Support custom scss, styled-components, material icons etc. :smile:
47+
48+
### Built With
49+
50+
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app)
51+
52+
<!-- GETTING STARTED -->
53+
54+
## Getting Started
55+
56+
To get this repo up and running on your local machine follow these simple steps.
57+
58+
### Prerequisites
59+
60+
Here's a list of things you'll need to have prior to installing the software.
61+
62+
- python
63+
- npm
64+
- nodejs
65+
- any modern web browser
66+
67+
### Installation
68+
69+
1. Setup virtual environment?
70+
71+
```sh
72+
$ virtualenv venv
73+
```
74+
75+
> Not necessary but recommended to keep your environment clean.
76+
> Dont forget to activate it.
77+
78+
2. Clone the repository to local machine.
79+
80+
```sh
81+
$ git clone https://github.com/SDOS2020/Team_3_Reactonite.git
82+
```
83+
84+
2. Install the package either using pip or python setup tools
85+
86+
```sh
87+
$ python setup.py install
88+
# Use `develop` instead of `install` to get an editable build
89+
90+
# Alternatively run
91+
$ pip install .
92+
```
93+
94+
3. You are good to go... 🎉
95+
96+
<!-- USAGE EXAMPLES -->
97+
98+
## Usage
99+
100+
Once installed refer to the [documentation](https://reactonite.github.io/reactonite/) 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.
101+
102+
```sh
103+
$ reactonite --help
104+
Usage: reactonite [OPTIONS] COMMAND [ARGS]...
105+
106+
Entry point for Reactonite cli.
107+
108+
Options:
109+
--help Show this message and exit.
110+
111+
Commands:
112+
...
113+
```
114+
115+
<!-- ROADMAP -->
116+
117+
## Roadmap
118+
119+
See the [open issues](https://github.com/SDOS2020/Team_3_Reactonite/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](https://github.com/SDOS2020/Team_3_Reactonite/projects) tab.
120+
121+
<!-- CONTRIBUTING -->
122+
123+
## Contributing
124+
125+
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](https://github.com/SDOS2020/Team_3_Reactonite/blob/beta/CONTRIBUTING.md).
126+
127+
<!-- LICENSE -->
128+
129+
## License
130+
131+
License yet to be decided. See `LICENSE` for more information once complete.
132+
133+
<!-- CONTACT -->
134+
135+
## Contact
136+
137+
- Amogh Gulati - amogh17019@iiitd.ac.in
138+
- Aniket Pradhan - aniket17133@iiitd.ac.in
139+
- Avi Garg - avi17223@iiitd.ac.in
140+
- Chirag Jain - chirag17041@iiitd.ac.in
141+
142+
Project Link: [https://github.com/SDOS2020/Team_3_Reactonite](https://github.com/SDOS2020/Team_3_Reactonite)

‎cli/README.md‎

Whitespace-only changes.

‎core/README.md‎

Whitespace-only changes.

0 commit comments

Comments
 (0)