webiny / webiny-js Goto Github PK

Open-source serverless enterprise CMS. Includes a headless CMS, page builder, form builder, and file manager. Easy to customize and expand. Deploys to AWS.

Home Page: https://www.webiny.com

License: Other

JavaScript 15.87% CSS 0.17% HTML 0.03% TypeScript 83.73% SCSS 0.19%

graphql react serverless nodejs cms microservice javascript typescript lambda spa

webiny-js's Introduction

Open-Source Serverless Enterprise CMS

Website | Documentation | Community Slack | Forum | Twitter

product-video-2022.mp4

Webiny Serverless CMS includes:

1️⃣ Page Builder - Drag&drop page editor. Pages are prerendered automatically and cached on CloudFront for lightning-fast delivery.

2️⃣ Headless CMS - Headless CMS with a GraphQL API. Build APIs and content models through a UI. It includes content revisions, localization, and fine-grain permission control.

3️⃣ File Manager - Upload files images. Search and organize your assets. It includes a built-in image editor for basic image manipulations.

4️⃣ Form Builder - Build forms with a drag&drop editor. Insert forms through Page Builder into your pages. It has webhook support and ReCaptcha integration.

All Webiny apps can be customized easily to fully fit an enterprise publishing workflow and integrate with leading identity providers like OKTA and Cognito.

🏁 Quick installation guide

Create a Webiny project:

npx create-webiny-project my-new-project

Deploy to your AWS cloud:

yarn webiny deploy

Prerequisites

Node.js ^12 || ^14
yarn ^1.22.0 || ^2
AWS account

For the detailed install guide, please see 👉 https://www.webiny.com/docs/tutorials/install-webiny

Need help, having trouble installing, find us on our community slack 👉 https://www.webiny.com/slack

📕 Documentation

For complete documentation 👉 https://www.webiny.com/docs

🤝 Community & Support

Community Forum. Best for: help with building, discussion about database best practices 👉 https://www.webiny.com/slack

GitHub Issues. Best for: bugs and errors you encounter using Webbiny 👉 https://github.com/webiny/webiny-js/issues

💪 Contributing

Webiny is all about the community. Please feel free to join in, whether it's fixing bugs, improving our documentation, or simply spreading the word. Please see our Contributing Guidelines, which explain project organization, setup, testing, and other steps. If you need any assistance in contribution, please reach out via our community Slack.

📜 License

This project is licensed under the terms of the MIT license except for the following modules, which require a Webiny Enterprise license:

Multi-tenancy module
OKTA integration

Contact [email protected] for more information.

Why are those modules paid? It's a way we support the development of the project!

👷‍♀️ When to use Webiny?

Webiny has many features, too many to list to make this readme digestible, so instead of talking about features, here are the common use-cases you can satisfy using Webiny:

Headless CMS - Programmatically integrate your apps with Webiny's GraphQL Headless CMS.
GraphQL API - You can build a GraphQL API using the Headless CMS, but you can also use the webiny scaffold command to create new GraphQL resolvers where you can add your custom business logic.
Marketing landing pages and micro-sites - Using the Page Builder marketing teams can quickly build new websites without knowledge of HTML or CSS.
Multi-tenant SaaS applications - Webiny has a robust multi-tenancy layer with built-in data separation. You can build your own SaaS applications on top and let Webiny handle the API, security, and data storage for you.
Full-stack serverless applications - Besides using Webiny to manage your content needs, you can expand the existing functionality by creating new full-stack serverless applications on top. Follow this tutorial to build your own full-stack serverless Pinterest clone.
Multi-website & multi-language portal - All Webiny apps are multi-tenant by default, meaning with a single instance of Webiny, you can run hundreds of projects and websites from a single code-base.
Dynamic Page ^{(coming soon)} - We're working on seamless integration between the Headless CMS and the Page Builder, so you can build and publish dynamic pages without a single line of code or build pipelines required. New content is live instantly and visible to the users.
Multi-cloud support ^{(coming soon)} - At the moment, Webiny only supports AWS, but we have plans to add support for other cloud vendors such as GCP and Azure. Because Webiny uses cloud-native services to run, not containers, this task is not easy, but we have a plan.

❓ FAQ

♦ Why serverless?

We believe serverless is the future of web development. It gives us much more bang for our buck!

♦ Why open-source?

Open-source has two main aspects over SaaS:

It's customizable, unlike being locked in a SaaS solution.
Your data is stored under your rules, in your data center, with your compliance standard inside your security parameter and delivered through your CDN.

♦ How is this enterprise?

Webiny is built to be integrated inside enterprise environments. Being open-source is one part of that solution; the other is that Webiny integrates with enterprise IdPs such as OKTA and Cognito.
Webiny is architected to sustain heavy usage coming from large volumes of users.
Webiny is built on top of fault-tolerant serverless services.
Webiny keeps the data encrypted both in transit and at rest.
In the paid edition, enterprises have access to our SLA-based support and consultancy services.

♦ How fast and scalable is Webiny?

How about a load-test :)

♦ How much does it cost to run Webiny?

Webiny comes in 2 database options, DynamoDB + Elasticsearch and DynamoDB only. The latter option, when looking at all the infrastructure pieces Webiny uses to operate, the consumption of the AWS services fully determines the cost. In the DDB + ES option, there is a minimum ~$25/mo charge to AWS for the Elasticsearch cluster as it's not a consumption-based service.

As part of our performance benchmark, we also benchmarked the cost of the DDB + ES, specifically, Headless CMS read and write operations. So that benchmark is a good starting point to determine your cost.

As a rule of thumb, we recommend the DDB option for small and medium-size projects, which should be cheaper when compared to a solution running on VMs or containers.

♦ Why should my enterprise consider using Webiny?

Top 5 reasons to do so:

Self-hosted: Webiny runs inside your own AWS cloud; you keep control over your data and security perimeter.
Open-source: We released Webiny under the MIT license, so you can customize every aspect of the system to match your needs fully.
Serverless: Webiny runs on AWS services such as Lambda, S3, and DynamoDB, to offer a highly scalable and fault-tolerant infrastructure.
Cost-savings: Cut your infrastructure and operations costs by 60% to 80% compared to solutions running on VMs.
Secure: Webiny follows security best practices by encrypting data both in transit and rest across all services. It integrates with IdPs such as OKTA and Cognito. CodeQL and Dependabot scanning tools ensure code security.

Contributors

🧡 Thanks goes to these wonderful people!

webiny-js's People

Contributors

Stargazers

Watchers

Forkers

ahmad-saleem jslibrarydirectory muphet widgeticdev captake thaneacheron gourav-singhal krbergola bawerd andrey-kovinjonok rubenbase popo1221 shaunstanislauslau 15001217168 rahulsoibam hhy5277 kingzez jangocheng santoshgistto kbsbroad ankitpr89 kale-code afrog33k gatarelib ajaysinghj8 themacmarketer sadiqmmm awannabecoder salmaanrizvi intfrr mznsolucoes tianlang0704 ashack bsyslient karthik-cbe parampavar nilportugues nax3t qwdingyu medampudi b3838438org michal7 mstruebing wisedemic anbu-latecso gcheliz varevarao chengjingfeng eramax ubani fvncent fossabot butonix bbbbb38438 smburrows udhayamgit sa-lab 24wings rxsoft-paris ezing lazerhawk maniacs-oss wudijuji alphadevglobal forkkit fpravica veerjainatgmail rpalmite amasser ac-forks fritexvz jetuni saksham93 marwan360 roman-vabishchevych amarc27 gitter-badger longjohncoder parkerproject ajesse11x chwenliu val-fom cctoni nathanbrowndigital andreamorone leonletto hustlelikeaboss danyrupes glennneiger naokia jbampton vividwombat nazartrynko jamesgeorge007 ahmdtalat 0xyittle g03024735 thedemodev mesutcakir antondashevsky

webiny-js's Issues

Offer passing custom ID validation callback

Currently if idGenerator is set, driver assumes that it needs to be a string and that's the only validation step in the isId method.

Add the ability to pass a custom ID validation callback, in which users might execute more sophisticated validation.

Rename where to query (more neutral naming)

As the title says, change .find({where: {}}); to .find({query: {}}); since keyword where is more specific to MySQL, but eg. not for MongoDB.

entities attribute - many2many support

Enable many2many support.

webiny-entity-mysql - add affectedRows to meta

Where possible, add this to meta of created QueryResults

get method for safely fetching nested attributes in entity

Some attributes might be async, so it would be more convenient to expose a dedicated method that will take care of this problem.

Example:

entity.get('company.image.src');

Not throwing correct errors

Check webiny-entity completely and ensure instances of EntityError classes are thrown instead of plain Error.

webiny-entity-mysql - Add tests for connection pool / connection

Entity attribute - save linked entity only if dirty

Currently when saving main entity, linked entity will be saved if it was instantiated. Add additional checking - only save if actually something has changed in the loaded linked entity.

Implementing this would improve performance.

EntityCollection

Create entity collection and ensure it contains all sent params meta data.

Data extractor - test with a simple array

Test with a mock that has an array of primitive values, instead of objects.

Node: inspect trajectory.

Add support for table name

webiny-entity-mysql currently uses classId as a table name. It should be able to receive a custom table name (useful when users already have tables in an existing database).

Allow params or connection instance

On construct, users should be able to send params directly (that will configure mysql pool) or an instance of already existing mysql connection or pool.

Entity attribute - using feature

Entity attribute should also have setUsing method for setting an aggregation entity over which the main linked entity will be loaded.

Example:
this.attr('company').entity(Company).setUsing(CompaniesUsers, 'company');

MySQL driver - add option for automatic inclusion of createdOn, modifiedOn and deletedOn attributes

As the title says, driver will receive an option, which if enabled, will tell the driver to automatically append createdOn, modifiedOn and deletedOn attributes and update these accordingly.

Note: this can be implemented on the base driver as a default option that can be implemented on any driver.

Validation instance must set validator name and value on the error thrown from the validator

Tests - use sinon js with sandboxes to prevent not-restoring spies/stubs on errors

Test - entity attribute (save method)

Ensure that if multiple nested entities are linked, that if validation fails on one, that main save fails.

Note 1: currently if most nested entity validates successfully, it will be saved, even if the parent entity is invalid (which is determined after the child entity got saved).

Note 2: if entity is loading, it must be validated - test that case.

Entity attribute - check initial deletion

Add additional test, which will ensure that initial entity gets deleted whether it was loaded or not.

EntityCollection

Forbid appending anything that is not an instance of Entity class.

Entity/entities attributes - Improve validation check

"validate" method does not take into consideration isLoaded/isLoading flags.

Create `EntityEndpoint` class to automatically handle common CRUD methods for the defined `Entity`.

Existing Endpoint class can be used to implement all kinds of API methods, but in business apps most of the endpoints are directly related to an underlying business entity (which holds data model and business logic).

EntityEndpoint should handle common CRUD methods to greatly reduce code duplication.

isId method on webiny-entity drivers

Sometimes, entity layer must check if given value is a valid ID. The best solution for this is to enable drivers to tell if the value is a valid id or not.

Implement isId(value) method on drivers.

Optimize toJSON method

Right now it has to convert the whole entity to JSON, which means often it will have to load entities.

That's a wrong approach, lazy load only what is needed.

Note 1: as any attribute, entity attribute has a getJSONValue method, and it will always return a whole JSON representation of an entity. This also must be taken care of.

Note2: this also causes problems when doing something like user.get('company.image.id'), where image has createdBy attribute, which links to the original user, because current behavior recursively fetches data.

isId - transform to async

Since developers might need to do async validation of ID using eg. webiny-validation, let's make this method async.

File storage package

Create a standalone file storage package with support for drivers.
Searching the npm gave me nothing I would want to use, google did not help either.

Goals: