https://github.com/sujeetkv/flaskcode
A web based code editor on python flask framework.
https://github.com/sujeetkv/flaskcode
code code-editor editor flask python python-web-ide web-ide
Last synced: 11 days ago
JSON representation
A web based code editor on python flask framework.
- Host: GitHub
- URL: https://github.com/sujeetkv/flaskcode
- Owner: sujeetkv
- License: mit
- Created: 2019-05-10T15:40:38.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2025-07-31T18:13:24.000Z (5 months ago)
- Last Synced: 2025-12-14T15:58:18.395Z (11 days ago)
- Topics: code, code-editor, editor, flask, python, python-web-ide, web-ide
- Language: JavaScript
- Homepage:
- Size: 22 MB
- Stars: 77
- Watchers: 4
- Forks: 35
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# flaskcode
[](https://github.com/sujeetkv/flaskcode/actions/workflows/test-workflow.yml)
[](https://pypi.org/project/flaskcode)
[](https://github.com/sujeetkv/flaskcode/blob/master/LICENSE)
Web based code editor on python flask framework.
## Installation
```bash
pip install flaskcode
```
## Run application from CLI
Run flaskcode standalone using following command:
```bash
flaskcode /path/to/resource/folder
```
Get help for CLI command:
```bash
flaskcode --help
```
```
Usage: flaskcode [OPTIONS] [RESOURCE_BASEPATH]
Run FlaskCode with given RESOURCE_BASEPATH or current working directory.
All options can be set on the command line or through environment
variables of the form FLASKCODE_*. For example FLASKCODE_USERNAME.
Options:
-h, --host TEXT IP or hostname on which to run HTTP server.
-p, --port INTEGER Port on which to bind HTTP server.
--username TEXT HTTP Basic Auth username.
--password TEXT HTTP Basic Auth password.
--editor-theme [vs|vs-dark|hc-black]
Editor theme, default is vs-dark.
--debug Run in flask DEBUG mode.
--env TEXT Flask environment, default is development.
--version Show the version and exit.
--help Show this message and exit.
```
## Integrating flaskcode in your Flask app
The flaskcode can be integrated in to your own `Flask` app by configuring and registering `flaskcode.blueprint` with your app:
```python
from flask import Flask
import flaskcode
app = Flask(__name__)
app.config.from_object(flaskcode.default_config)
app.config['FLASKCODE_RESOURCE_BASEPATH'] = '/path/to/resource/folder'
app.register_blueprint(flaskcode.blueprint, url_prefix='/flaskcode')
@app.route('/')
def hello():
return "Hello World!"
if __name__ == '__main__':
app.run()
```
Now if you run the Flask app on default port, you can access the flaskcode at http://127.0.0.1:5000/flaskcode.
## Built with
* [Flask](http://flask.pocoo.org) - a python web framework
* [Monaco Editor](https://microsoft.github.io/monaco-editor) - a browser based code editor
## Authors
* [**Sujeet Kumar**](https://github.com/sujeetkv)
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/sujeetkv/flaskcode/blob/master/LICENSE) file for details.