Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.41 KB

README.md

File metadata and controls

43 lines (25 loc) · 1.41 KB

Chatop Backend Project

This is the backend repository for the Chatop application.

Configuration

  1. Clone this repository to your local machine.
  2. Import the project into your favorite IDE (e.g., Eclipse, IntelliJ IDEA).
  3. Configure the database information using your own environment variables:
    • DATABASE_URL: Database URL
    • DATABASE_USERNAME: Database username
    • DATABASE_PASSWORD: Database password You can set these environment variables in your operating system.

Installation

  1. Open a terminal or command prompt.
  2. Navigate to the project's root directory.
  3. Run the following command to compile and build the project:

Running the Application

  1. In the same terminal or command prompt, run the following command to start the application:

  2. Make sure port 3001 is available on your machine. The application will be accessible at the following URL:

http://localhost:3001

API Documentation

The API documentation is automatically generated and can be accessed at the following URL:

http://localhost:3001/v2/api-docs

Author

This project was created by Thomas MICHEL. You can contact the author via email at:

Email: michelt.thomas@gmail.com

Feel free to explore the code and reach out to the author for more information about this exciting project and the author's backend development skills.