/reflex-web

A public repo of the reflex.dev website.

Primary LanguagePython

Reflex Logo Reflex Logo

✨ Performant, customizable web apps in pure Python. Deploy in seconds. ✨

PyPI version tests versions Documentation Discord

Overview

A public repository which contains the source code of the reflex.dev website.

  • It's built with Reflex, a framework to build web apps in pure Python.
  • You can find everything related to Reflex at reflex.dev.

About Reflex

Reflex is a full-stack web framework that allows developers to build their app in pure Python, and deploy with a single command. Its open-source core framework ensures flexibility for projects of any scale. Explore the future of web development at reflex.dev.

Requirements

The only requirement is that you have installed Python 3.9 or higher in your local machine.

Setup Locally

  1. Fork this repository by clicking on the Fork button on the top right.

  2. Clone the forked repository to your local machine.

    git clone https://github.com/<USERNAME>/reflex-web.git
  3. Navigate to the project directory.

    cd reflex-web
  4. Create a virtual environment.

    python3 -m venv venv
  5. Activate the virtual environment.

    source venv/bin/activate
  6. Install the dependencies.

    python -m pip install -r requirements.txt
  7. Initialize the reflex project.

    reflex init
  8. Run the project.

    reflex run

    Open the browser and go to http://localhost:3000/ to see the website.

Contributing

We welcome contributions of any size! Below are some good ways to get started in the Reflex community.

  • Join Our Discord: Our Discord is the best place to get help on your Reflex project and to discuss how you can contribute.
  • GitHub Discussions: A great way to talk about features you want added or things that are confusing/need clarification.
  • GitHub Issues: Issues are an excellent way to report bugs. Additionally, you can try and solve an existing issue and submit a PR.

We are actively looking for contributors, no matter your skill level or experience. To contribute check out CONTIBUTING.md

License

Reflex is open-source and licensed under the Apache License 2.0.