Giter Club home page Giter Club logo

node_exercise-pccw's Introduction

README - Node Exercise for PCCW Global

Development Environment Setup

To set up and run the application, follow these steps:

Initial Setup and Running the Application

  1. Build and Start the Application:
    • Open your terminal.
    • Navigate to the root directory of the project.
    • To build and start all the necessary applications at once, run the following command at the beginning:
      docker-compose up --build
      
      This command builds and starts all the containers required for the application, and it needs to be run only once at the beginning.

Step 2: Importing the Postman Collection

  • Open Postman.
  • Import the PCCW-GLOBAL.postman_collection.json file. This file contains the API requests you will need to interact with the backend.

Using the Application

Populating the Database

Before using the application, the database needs to be populated:

  1. Run the FeedDB Endpoint:
    • In Postman, execute the request to {{local_url}}/api/v1/feed/feedDB.
    • This endpoint will import data from the seed.xlsx file into the database.
    • If you encounter any errors during this process, restart the PostgreSQL and API containers, and then try again.

Accessing the Frontend

After populating the database, you can access the application's frontend:

  1. Visit the Web Application:
    • Navigate to http://localhost:3000/ in your web browser.

Viewing Message Exchanges

To see users exchanging messages:

  1. Use URL Parameters for Specific Data:
    • Access http://localhost:3000/?currentUserId=1&userID1=1&userID2=3 to view messages exchanged between specified users.
    • Modify the values of currentUserId, userID1, and userID2 in the URL as needed.

Additional Information

  • Please refer to this README for any special instructions or assumptions made during the development.
  • For further queries or issues not covered here, feel free to reach out for support.

node_exercise-pccw's People

Contributors

nikoskats avatar arvanitisgeorge avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.