Installation & Commands

Installation Guide for Etherial.TS

Welcome to Etherial.TS! To get started with this powerful web application framework, follow these simple installation steps. Etherial.TS requires Node.js version 16 or higher, and you can choose your preferred database type.

Prerequisites

Before you begin, make sure you have the following prerequisites installed on your system:

• Node.js: You'll need Node.js version 16 or higher. You can download it from https://nodejs.org/.

Installation Steps

Follow these steps to create a new Etherial.TS project:

Step 1: Clone the Etherial Skeleton Repository

To initiate a new project, you can start with the Etherial Skeleton repository. Open your terminal and run the following command:

git clone [email protected]:etherial-lab/etherial-skeleton.git project-name

This command will clone the Etherial Skeleton repository to your local machine.

Step 2: Install Dependencies

Navigate to the project directory that was created during the cloning process:

cd project-name

Now, install the project dependencies using Yarn:

yarn install

This command will download and install all the required dependencies for your Etherial.TS project.

Step 3: Configure .env File

You'll need to create or configure a .env file in your project's root directory. The contents of the .env file depend on your project's configuration. Below is a sample .env file with placeholders for your database and HTTP configuration:

NODE_ENV=dev

# If the database module is installed
DATABASE_SERVER=
DATABASE_DIALECT=
DATABASE_PORT=
DATABASE_USERNAME=
DATABASE_PASSWORD=
DATABASE_NAME=

# If the HTTP module is installed
HTTP_PORT=3100

Replace the placeholders with your specific configuration values. If you're using a database, provide the necessary database connection details. If you plan to use the HTTP module, set the desired port for your application.

Step 4: Start Your Etherial.TS Application

Once you've configured the .env file, you're ready to start your Etherial.TS application. Run the following command to start the development server:

yarn start

Your Etherial.TS application will now be running, and you can access it at the specified HTTP port (e.g., http://localhost:3100 if you set HTTP_PORT to 3100).

Congratulations! You've successfully set up a new Etherial.TS project and can now begin building your web application. Explore the framework's features and create your application's routes, controllers, and models to bring your project to life. Enjoy developing with Etherial.TS!