Quick Start

Ready to dive into SoapJS? Here's how you can get rolling with our framework. We've got three ways to get you set up, depending on what you're aiming for. Choose the one that fits your vibe:

Kick It Off with the Package

If you're familiar with the components and ready to jump straight in, you can add our package directly to your project. Here’s how:

Node

npm install @soapjs/soap

Start Fresh with CLI

For those of you looking to start fresh, our CLI tool is the way to go. First, ensure it's installed globally on your machine:

Node

npm install -g @soapjs/soap-cli

Then, initiate a new project with:

Node

soap new project

Here are the options you can use with this command:

Option	Description
-n, --name <value>	Sets the name of your new project.
-l, --lang <value>	Specifies the language (TypeScript or JavaScript).
-s, --source <value>	The path to the source folder, relative to the project root.
-f, --framework <value>	Chooses the web framework for the project.
-i, --ioc <value>	Selects the Inversion of Control library to use.
-d, --database [values...]	Lists the databases your project will utilize.
-h, --help	Displays help information for the command.

Don’t worry if you’re not sure about all the options; skipping them triggers an interactive form that guides you through the setup process.

Integrating SoapJS into an Existing Project

Already have a project that could benefit from Clean Architecture? Here’s how to add SoapJS to it:

Ensure the CLI is installed globally:

Node

npm install -g @soapjs/soap-cli

Initialize SoapJS in your project:

Node

soap init

Options for initialization are similar to creating a new project:

Option	Description
-f, --force	Forces the operation, overwriting files if necessary.
-l, --lang <value>	Sets the programming language for the project.
-s, --source <value>	Defines the path to the source folder.
-i, --ioc <value>	Determines the IoC library for the project.
-d, --database [values...]	Specifies which databases to integrate.
-h, --help	Shows the help guide for the command.

SoapJS supports TypeScript and JavaScript projects as of now, with plans to expand. Remember, you're not locked into any specific frameworks or plugins with SoapJS – feel free to explore and tailor your setup to your needs. Happy coding!

.soap/

When you initiate a new project or integrate SoapJS into an existing one, a .soap directory is created at the root of your project. This directory is crucial as it contains all the necessary configuration files and scripts that the CLI utilizes to operate effectively. More information about config here.