Skip to content

omnajjar/webrepub

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Webrepub

Webrepub is an open source web page editor 🚀 powered🔋 by React ✨ and Styled Components 💅. Our mission is to create a powerful React page editor that supports different presets of modern and popular components and design libraries that will make web development much faster and more fun.
Explore the docs »

View Demo · Report Bug · Request Feature

Product Name Screen Shot

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

Built With

  • React
  • Next
  • Typescript
  • Node
  • StyledComponents

(back to top)

Getting Started

Prerequisites

In order to run webrepub app locally you need to have Nodejs & npm on your machine.

Installation

  1. Clone the repo
    git clone https://github.com/omnajjar/webrepub.git
  2. Install NPM packages
    npm install
  3. Start development
    npm run dev

(back to top)

Roadmap

  • Add react-email preset
  • Make repo contribution ready

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make webrepub better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'feat: some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Osama Najjar - osama.najjar@webrepub.com | osama.najjar.m@gmail.com

(back to top)

Acknowledgments

(back to top)