Skip to content

Commit 43f4c37

Browse files
committed
first commit
0 parents  commit 43f4c37

24 files changed

Lines changed: 1232 additions & 0 deletions
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve the project
4+
title: "[BUG] "
5+
labels: bug
6+
---
7+
8+
**Describe the Bug**
9+
A clear and concise description of what the bug is.
10+
11+
**To Reproduce**
12+
Steps to reproduce the behavior:
13+
1. Code used: `...`
14+
2. Action performed: `...`
15+
3. Error message seen: `...`
16+
17+
**Expected Behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Environment:**
24+
- jsweb Version: [e.g., 0.1.1]
25+
- Python Version: [e.g., 3.11]
26+
27+
**Additional Context**
28+
Add any other context about the problem here.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve the project
4+
title: "[BUG] "
5+
labels: bug
6+
---
7+
8+
**Describe the Bug**
9+
A clear and concise description of what the bug is.
10+
11+
**To Reproduce**
12+
Steps to reproduce the behavior:
13+
1. Code used: `...`
14+
2. Action performed: `...`
15+
3. Error message seen: `...`
16+
17+
**Expected Behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Environment:**
24+
- jsweb Version: [e.g., 0.1.1]
25+
- Python Version: [e.g., 3.11]
26+
27+
**Additional Context**
28+
Add any other context about the problem here.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Publish to PyPI
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
build-and-publish:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Checkout code
13+
uses: actions/checkout@v3
14+
15+
- name: Set up Python
16+
uses: actions/setup-python@v4
17+
with:
18+
python-version: '3.x'
19+
20+
- name: Install dependencies
21+
run: |
22+
python -m pip install --upgrade pip
23+
pip install build twine
24+
25+
- name: Build package
26+
run: python -m build
27+
28+
- name: Publish to PyPI
29+
env:
30+
TWINE_USERNAME: __token__
31+
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
32+
run: twine upload dist/*

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to JsWeb.
2+
3+
First off, thank you for considering contributing. It's people like you that make open-source such a great community. Any contributions you make are **greatly appreciated**.
4+
5+
## How to Contribute
6+
7+
We use a standard workflow for contributions. If you have an improvement, please follow these steps:
8+
9+
1. **Fork the Project**
10+
* Click the "Fork" button at the top right of the repository page. This creates a copy of the project in your own GitHub account.
11+
12+
2. **Create a New Branch**
13+
* From your forked repository, create a new branch to work on your feature or bug fix.
14+
* `git checkout -b feature/MyAmazingFeature` or `git checkout -b fix/MyBugFix`
15+
16+
3. **Make Your Changes and Commit**
17+
* Write your code and make sure to add comments and docstrings where necessary.
18+
* Commit your changes with a clear and descriptive commit message.
19+
* `git commit -m 'feat: Add some AmazingFeature'`
20+
21+
4. **Push to Your Branch**
22+
* Push your committed changes to your forked repository on GitHub.
23+
* `git push origin feature/MyAmazingFeature`
24+
25+
5. **Open a Pull Request**
26+
* Go to the original repository and you will see a prompt to create a Pull Request from your new branch.
27+
* Provide a clear title and description for your changes, explaining what you've added or fixed.
28+
29+
## Reporting Bugs
30+
31+
If you find a bug, please create an issue on the GitHub repository. When you do, please include:
32+
33+
* Your version of jsweb and Python.
34+
* A clear and concise description of the bug.
35+
* The exact steps needed to reproduce the issue.
36+
* Any relevant code snippets that cause the bug.
37+
38+
## Suggesting Enhancements
39+
40+
If you have an idea for a new feature, please open an issue to discuss it. This lets us track the suggestion and allows others to chime in. In your issue, please provide:
41+
42+
* A clear description of the feature.
43+
* An explanation of the problem this feature would solve.
44+
* A code example or use-case, if possible.
45+
46+
Thank you again for your contribution!

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Jones Peter
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

MANIFEST.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
recursive-include jsweb/templates *.html
2+
recursive-include jsweb/static *.css

0 commit comments

Comments
 (0)