Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 3.1 KB

README.md

File metadata and controls

76 lines (50 loc) · 3.1 KB
Raw
Reflex Logo Reflex Logo

✨ The open-source framework to build and deploy web apps - no Javascript required. ✨

PyPI version tests versions Documentation Discord

Screenshot 2024-09-25-13 24 35

Overview

Welcome to the repository for the Reflex website!

Our website is built using our own framework: Reflex.

Reflex is the open-source framework empowering Python developers to build web apps faster. Build both your frontend and backend in a single language, Python (pip install reflex), with no JavaScript or web development experience required.

Requirements

We recommend using a virtual environment with Python 3.10 or higher to run this project.

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.

  3. Navigate to the project directory.

  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. 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! Feel free to open issues, especially for sections of the documentation that you find confusing or need clarification.

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.
  • Join our Discourse: Our forum is 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.