Getting Started With Spiderly
Follow this quick start guide to configure and initialize your Spiderly app.
Once complete, you'll be ready to use all features and build with its full power.
Prefer Watching Instead?
You can follow along with the video walkthrough. It covers all the steps from this guide, assuming you've already completed the first step — installing the prerequisites.
1. Install Prerequisites
Before getting started with Spiderly, make sure you have the following prerequisites installed:
- SQL Server 2022 Developer (if you already have SQL Server Express installed, no need to install the Developer edition)
- Node.js
-
Code Editors (Recommended):
- Backend: Visual Studio (Community Edition)
- Frontend: Visual Studio Code
- Skip this step if you installed Visual Studio in a previous step - .NET 9.0
- Run the global Angular CLI and EF Core CLI installation command from any location in the terminal: npm install -g @angular/cli && dotnet tool install -g dotnet-ef
- SQL Server Management Studio (SSMS)
- Visual Studio Code Extension: Angular Language Service
2. Install the Spiderly CLI
Run the Global Spiderly CLI installation command from any location in the terminal:
3. Initialize the App
Run this command in the folder where you want your app to be located:
4. Start the Backend
Open the backend project located at your-app-name\Backend\YourAppName.sln using Visual Studio and click the IIS Express run button to start the backend.
5. Start the Frontend
Open the frontend project located at your-app-name\Frontend using Visual Studio Code. Then open a new Visual Studio Code terminal via Terminal -> New Terminal (or press Ctrl + Shift + `) and run the command:
6. Set Up Emailing
In the backend project opened with Visual Studio, locate the YourAppName.WebAPI\appsettings.json file and set the following fields:
- "EmailSender" - Set this to the existing email address you want to use for sending various types of emails, such as verification codes, unhandled exception alerts, and notifications.
- "EmailSenderPassword" - Do not use your regular Gmail password. This must be the Gmail App Password for the same email account specified in "EmailSender". Follow the video tutorial to see how to generate an Gmail App Password from your Google account.
7. Set Up Google Authentication
After following the video tutorial, you will obtain the Google Client ID. Once you have it, make sure to set it in the following two places:
- In the backend project opened with Visual Studio, locate the YourAppName.WebAPI\appsettings.json file and set the value for the "GoogleClientId".
- In the frontend project opened with Visual Studio Code, locate the src\environments\environment.ts file and set the value for the "GoogleClientId".
8. Register the User
Use the UI of your generated app to register the user via email or Google.
9. Connect to SQL Server
- Open SQL Server Management Studio (SSMS).
-
In the Connect to Server window, fill in the fields as follows:
- Server Name: localhost
- Authentication: Windows Authentication
- Database Name: <default>
- Encrypt: Mandatory
- Trust Server Certificate: True
- Color: <default>
- Click the Connect button.
10. Assign Admin Permissions
Execute the script located at your-app-name\Database\initialize-script.sql using SQL Server Management Studio to assign admin permissions to the previously registered user.