Tutorial series - #1 Introduction

First part from upcoming tutorial series for Total.js. The Series will be focused on the absolute basics of the framework, where you will learn best practices and common approaches to different situations and problems. In this part, we will set up our Total.js app.

What is Total.js?

Total.js is a full-stack Node.js framework for creating web applications, REST services, real-time applications, and much more. The framework is in development for more than eight years, it's fully open-source, and it's written in pure javascript.

Core features of Total.js:

• Web server
• Clustering
• Websocket (server & client)
• Handling of static files (upload & download)
• NoSQL embedded database (TextDB)
• SMTP sender
• Components
• File storage
• Workers
• Number, String, Date, and Array prototypes

Project structure

Try to always follow Total’s directory structure for better readability and orientation in your application. Start script for every Total app is index.js, and the file for configuration of your app is config. Both are located at the root of your app. Learn more about configuration.

Below are some main Total’s directories with short usage description:

• Builds - Directory for Total.js Application Builder scripts
• Controllers - For declaring routes for your application
• Definitions - Scripts for overwriting or adding Total’s functionality
• Private - You can store here your scripts or certificates
• Public - Anyone can access this folder outside this app
• Schemas - Are for handling and processing received data, mostly from controllers
• Views - Total’s view files for rendering

All lists of directories and files can be founded in our documentation

Setup

Local

Download Total.js, our starting template from GitHub, run npm install, and after that run node index.js command inside the root of your project. You can find more templates that fit your needs here.

Cloud

A more straightforward, practical, and efficient way is to use our Rapid Cloud Development with app management tool SuperAdmin, Code editor with full support for Total.js, and many other additional features for more accessible and smoother development.

Step-by-Step guide

1. Sign in to Total.js Platform
2. Pick a container that fits your needs
3. Select apps you want to install (Don't forget Code app so you can edit your apps)
4. Open SuperAdmin by clicking "Super Admin" on your new container
5. Create your first app:
   1. In the upper-right corner click Add
   2. You can change the internal name of the app or customize some settings
   3. Click submit button and wait until the following form appear
   4. Select source-code for your application (or use our templates)
   5. Click submit button
6. Open your code app in your SuperAdmin
7. Select your app in the upper-left menu
8. Start coding

You can learn more about the Total.js platform and our other projects on our official site.