SHIELD.JS

The new frontend project by One Beyond. From developers, to developers.

Why Shield.js - Key Features - Getting Started - System Requirements - Installation - Meet the team - Contributing - License

❓ Why Shield.js

Shield.js

Shield.js is a new project powered by One Beyond that provides a comprehensive set of frontend tools that every developer uses on a daily basis. Leaving aside the tedious procedure of installing the same tools over and over again, with Shield.js the developer will find a lot of the necessary packages once the installation process is finished.

The philosophy behind Shield.js

Always from the developer's perspective and understanding the time involved in the process of starting a project, we have the necessity to propose a general solution that covers and speeds up the first steps at the beginning of the project and, in this way unify as much as possible the tools and technologies that will take prominence throughout the life of the project. That is why, for frontline developers, we have created Shield.js

🔑 Key Features

Some of the key features of Shield.js include:

Easy to install, easy to use
Project scaffolding using day to day technologies
- React
- TypeScript
- Vite
- Playwright
- Hygen
- Styled Components

🏁 Getting Started

Because a picture is worth a thousand words... 📹

🛠 System requirements

It is necessary to have these packages updates to:

node: v18.12.1
npm: v8.19.2

🏗 Installation

For the time being, Shield.js can be installed from source

# Clone this repository
$ git clone https://github.com/onebeyond/shieldjs.git

# Go into the repository
$ cd shieldjs

# Install dependencies
$ npm install

# Run the app
$ npm run start

🫂 Meet the team

We are the members from the Frontend Chapter in One Beyond. This is us:

_{Javier G. Leal}

_{Jose Manuel Torralvo}

📖 Documentation

For more information on how to use ShieldJS, please refer to the official documentation.

❤️ Contributing

Do you feel you can contribute or give feedback to the project?

If you would like to contribute to ShieldJS, please feel free to submit a pull request or open an issue on the GitHub repository. We welcome contributions of all kinds, including bug fixes, feature enhancements, and documentation improvements.

If you only want to highlight our project because it helped you in some way, you can give us a ⭐️ !

✅ License

ShieldJS is licensed under the MIT License.

onebeyond / shieldjs

readme