Environment Requirements

To run the KlinicCon project locally, ensure that the following software and dependencies are installed on your development machine.

1. Node.js

• Version: 14.x or higher
• Installation Guide: Node.js Official Website
• Description: Node.js is required to run the JavaScript environment, particularly for managing the frontend with React.

2. React

• Version: 17.x or higher
• Documentation: React Official Documentation
• Description: React is used to build the user interface of the application. It is essential for developing and running the frontend components.

3. Vite

• Version: Latest
• Installation Guide: Vite Official Documentation
• Description: Vite is a build tool that significantly improves development speed with React. It is required for compiling and bundling the frontend code.

4. Ruby

• Version: 3.x or higher
• Installation Guide: Ruby Official Website
• Description: Ruby is necessary for running the backend server using Ruby on Rails. It powers the server-side logic and API.

5. Ruby on Rails

• Version: 7.x or higher
• Installation Guide: Rails Official Guide
• Description: Rails is a web application framework that runs on Ruby, used to develop and manage the server-side functionalities of KlinicCon.

6. PostgreSQL

• Version: 12.x or higher
• Installation Guide: PostgreSQL Official Website
• Description: PostgreSQL is a relational database management system. It is required for storing and managing the application's data.

7. Yarn

• Version: 1.x or higher
• Installation Guide: Yarn Official Website
• Description: Yarn is a package manager for JavaScript. It is used to install and manage the JavaScript dependencies required for the frontend.

8. Git

• Version: Latest
• Installation Guide: Git Official Documentation
• Description: Git is a version control system used for tracking changes in the source code and facilitating collaboration with other developers.

Additional Tools

• Editor: Visual Studio Code aka VSCode or any preferred code editor.
• Browser: Latest version of Chrome, Firefox, or Edge for testing and development.

---

Backend Setup

This section describes the what is required for the backend of the KlinicCon project, which is built using Ruby on Rails.

1. Clone the Backend Repository:

   • Repository Link: KlinicCon Backend Repository
   • Use the following command to clone the backend repository: <> git clone https://github.com/rt4914/KlinicCon-Frontend.git

2. Install Ruby on Rails:

   • Ensure Ruby and Rails are installed as specified in the environment requirements above.
   • Install the required gems using Bundler: <> bundle install

3. Set Up the Database:

   • Make sure PostgreSQL is installed and running.
   • Create and migrate the database: <> rails db:create rails db:migrate

4. Run the Backend Server:

   • Start the Rails server using the command: <> rails server

   • The server will run at http://localhost:3000 or http://127.0.0.1:3000 by default.

---

Frontend Setup

This section describes the what is required for the frontend of the KlinicCon project, which is built using React and Vite.

1. Clone the Frontend Repository:

   • Repository Link: KlinicCon Frontend Repository
   • Use the following command to clone the frontend repository: git clone https://github.com/YOUR_USERNAME/kliniccon-frontend.git

2. Install Node.js and Yarn:

   • Ensure Node.js and Yarn are installed as specified in the environment requirements above.

3. Install JavaScript Dependencies:

   • Navigate to the frontend project directory: cd kliniccon-frontend

   • Install the dependencies using Yarn: yarn install

4. Run the Frontend Development Server:

   • Start the Vite development server using the command: yarn dev

   • The development server will run at http://localhost:5173 by default.

---

Notes

• Ensure all installations match or exceed the specified versions to avoid compatibility issues.
• Follow the linked installation guides to set up each tool correctly.
• After setting up the environment, refer to the project’s README.md for detailed instructions on running the project.

By following the above requirements and setup instructions, you will have all the necessary tools and configurations to develop and run the KlinicCon project on your local machine.