WebClient

This is the official WebClient for the OpenEdu. Visit Project Details to learn more about the project.

Getting Started

To set up the WebClient, follow the comprehensive steps below:

Step 1: Install Dependencies

Make sure you have Node.js installed. Navigate to the WebClient directory and install the required dependencies:

npm install
# or
yarn

Step 2: Run Development Server

Launch the development server to preview and test the web client:

npm run dev
# or
yarn dev

This will start the development server, and you can access the web client at http://localhost:3000 in your browser.

Step 3: Set Up the Backend Server

Choose one of the following options to set up the backend server:

1. Local Server Setup: Follow the instructions in the Manual Server Setup Documentation to run the server locally.

2. Dockerized Server Setup: Use the Docker image by following the instructions in the Docker Installation Documentation.

Ensure the backend server is running and accessible before proceeding.

Step 4: Explore API Documentation and Demo Calls

Check the API Documentation to discover available endpoints and their usage. This comprehensive guide will help you understand how to interact with the backend server and make informed API calls.

Feel free to experiment with the provided demo calls to better understand the functionality.

Step 5: Additional Notes

• This WebClient is designed to work seamlessly with the specified backend server. Ensure that the backend server is configured correctly to support WebClient functionalities.

• For any issues or further assistance, refer to the official documentation or reach out to the community for support.

Now you're all set to explore and utilize the WebClient for your development needs!