Getting Started

This page will help you set up the nestjs-socketio-chat on your computer. Follow these steps to get started with this real-time chat application backend.

Step 1: Clone the Repository

First, you need to get the project files on your computer. You can do this by cloning the repository with Git. Open your command line or terminal and run:

git clone https://github.com/vontanne/nestjs-socketio-chat.git

Step 2: Install Dependencies

After cloning, enter the project directory:

cd nestjs-socketio-chat

Then, install all necessary dependencies using npm:

npm install

Step 3: Create Environment File

Next, you need to set up the environment variables. Copy the example environment file:

cp .env.example .env

Then open the .env file and customize the settings for your server and authentication details.

Step 4: Set Up the Database

Run the database migrations to set up your SQLite database and tables:

npm run migration:run

Step 5: Launch the Application

Now, you are ready to start the server. You can run the server in development mode, which will reload automatically if you make any changes:

npm run start:dev

Or, to run it in production mode:

npm run start:prod

Next Steps

• Test the application: Use a tool like Postman to test the API endpoints.
• Read the documentation: Learn more about the features and how to use them in the project's README file and other wiki pages.

For any help or to share feedback, feel free to engage with the community through the project's discussions page.