API Documentation

This README provides instructions on how to access the API documentation for this project. The API documentation is powered by Swagger UI and is available on your local development server.

Prerequisites

• Git
• Node.js (version 14 or later recommended)
• npm (comes with Node.js)

Getting Started

1. Clone the repository:

bash
git clone https://github.com/galacticpolymath/gp-frontend
cd gp-frontend

2. Install dependencies:

bash
npm install

3. Start the development server:

bash
npm run start

Accessing the API Documentation

For the online version: https://gp-yauu.readme.io/reference/

Once your local development server is running, you can access the API documentation by following these steps:

1. Open your web browser.
2. Navigate to: http://localhost:3000/api/docs

This will open the Swagger UI interface, where you can explore and interact with the API endpoints.## Features of the API Documentation

• Interactive API exploration
• Detailed information about each endpoint, including:* HTTP methods
  • Request parameters
  • Response schemas
  • Example requests and responses
• Try-it-out functionality to test API calls directly from the browser

Troubleshooting

If you encounter any issues:

1. Ensure your development server is running.
2. Check that you're using the correct port (default is 3000).
3. Clear your browser cache or try in an incognito/private window.

For any further assistance, please open an issue in the GitHub repository.