Update README.md
parent
cfd5a6d9ef
commit
285f129f53
91
README.md
91
README.md
|
|
@ -133,97 +133,6 @@ cd SWAPSTATION_WEBAPP
|
||||||
|
|
||||||
This will open the application in your browser, typically at http://127.0.0.1:5500.
|
This will open the application in your browser, typically at http://127.0.0.1:5500.
|
||||||
|
|
||||||
► API Endpoints Overview
|
|
||||||
|
|
||||||
The backend provides the following main RESTful API endpoints. All are prefixed with /api.
|
|
||||||
|
|
||||||
Endpoint
|
|
||||||
|
|
||||||
|
|
||||||
Method
|
|
||||||
|
|
||||||
|
|
||||||
Description
|
|
||||||
|
|
||||||
/login
|
|
||||||
|
|
||||||
|
|
||||||
POST
|
|
||||||
|
|
||||||
|
|
||||||
Authenticates a user.
|
|
||||||
|
|
||||||
/users
|
|
||||||
|
|
||||||
|
|
||||||
POST
|
|
||||||
|
|
||||||
|
|
||||||
Adds a new user account.
|
|
||||||
|
|
||||||
/stations
|
|
||||||
|
|
||||||
|
|
||||||
GET
|
|
||||||
|
|
||||||
|
|
||||||
Retrieves a list of all stations.
|
|
||||||
|
|
||||||
/stations
|
|
||||||
|
|
||||||
|
|
||||||
POST
|
|
||||||
|
|
||||||
|
|
||||||
Adds a new station to the system.
|
|
||||||
|
|
||||||
/stations/<id>
|
|
||||||
|
|
||||||
|
|
||||||
DELETE
|
|
||||||
|
|
||||||
|
|
||||||
Removes a station from the system.
|
|
||||||
|
|
||||||
/stations/daily-stats
|
|
||||||
|
|
||||||
|
|
||||||
GET
|
|
||||||
|
|
||||||
|
|
||||||
Gets swap statistics for all stations (last 24h).
|
|
||||||
|
|
||||||
/analytics
|
|
||||||
|
|
||||||
|
|
||||||
GET
|
|
||||||
|
|
||||||
|
|
||||||
Fetches detailed historical analytics data.
|
|
||||||
|
|
||||||
/logs/recent/<id>
|
|
||||||
|
|
||||||
|
|
||||||
GET
|
|
||||||
|
|
||||||
|
|
||||||
Retrieves recent logs for a specific station.
|
|
||||||
|
|
||||||
/logs/export
|
|
||||||
|
|
||||||
|
|
||||||
GET
|
|
||||||
|
|
||||||
|
|
||||||
Exports logs as a CSV file.
|
|
||||||
|
|
||||||
/uptime/<id>
|
|
||||||
|
|
||||||
|
|
||||||
GET
|
|
||||||
|
|
||||||
|
|
||||||
Gets the live uptime percentage for a station.
|
|
||||||
► Deployment
|
► Deployment
|
||||||
|
|
||||||
This application is designed for production deployment using Docker. For detailed, step-by-step instructions on how to deploy the application to an AWS server, please refer to the official guide:
|
This application is designed for production deployment using Docker. For detailed, step-by-step instructions on how to deploy the application to an AWS server, please refer to the official guide:
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue