Social-Media-App

Table of Contents

• Social-Media-App
  • Table of Contents
  • Installation
  • Usage
    • Running the Project
    • Development Mode
    • Linting
  • Contributing
  • License

Installation

To get started with this project, follow these steps:

1. Clone this repository to your local machine:

   git clone https://github.com/aditipolkam/social-media-api

2. Navigate to the project directory:

   cd social-media-api

3. Install project dependencies using npm:

   npm install

Usage

After the installation is complete, you can use the following commands to run and develop the project:

Running the Project

To build and run the project in production mode, use the following command:

npm start

This will transpile TypeScript files and run the application.

Development Mode

To run the project in development mode with automatic code reloading, use the following command:

npm run dev

This uses nodemon to monitor changes to TypeScript files and restarts the application automatically.

Linting

To run ESLint for linting TypeScript files, use the following command:

npm run lint

This command will help you maintain code quality by identifying and fixing issues in your code.

Contributing

If you would like to contribute to this project, please read our Contributing Guidelines for more information.

License

This project is licensed under the MIT License - see the LICENSE file for details.