Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 2.61 KB

README.md

File metadata and controls

69 lines (43 loc) · 2.61 KB

Colab-users - Frontend

This section pertains to the frontend aspect of the entire project. Its purpose is to display user cards containing essential information and provide a detailed page for each user.

Table of Contents

Installation

Warning

To view the users in this part of the project, it's necessary to start the backend. You can do this by following the installation steps

Please follow these steps to get started:

  1. Clone the project repository and navigate to the colab-users folder:
git clone [email protected]:ldantas-s/colab-users.git && cd colab-users
  1. Enter into the frontend folder and install the dependencies:
cd frontend && yarn
  1. Run the frontend project:
yarn dev

Running with Docker

If you prefer to run this part of the project using Docker, follow these steps:

docker build -t <image_name_you_prefer> .
docker run --name <container_name_you_prefer> -p 5173:5173 <image_name_you_prefer>

Replace <image_name_you_prefer> with the desired name for your Docker image, and <container_name_you_prefer> with the preferred name for your Docker container. These commands will build the Docker image and then run the container, making the application accessible at http://localhost:5173. Adjust the port number if needed.

Tip

You can bring up both the frontend and backend parts of the project by following the installation steps

Usage

When you execute the command yarn dev, it automatically runs with the --host flag, allowing you to access the application from your phone or other devices. Simply look for the Network: <ip_address>:5173 in the terminal output to find the address you need to access from the other device. Alternatively, you can access the application directly in your local browser using the URL http://localhost:5173.

Documentation

You can find more documentation about this project in both the root and backend README.

License

This project is licensed under the MIT License, allowing for flexible use and modification while ensuring proper attribution.

Contacts

For questions or feedback, feel free to contact me at [email protected]. I welcome any questions or suggestions you may have. Additionally, you can check out my website and LinkedIn profile for more information: