37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
# Authentication API
|
|
|
|
This is a README file for the Authentication API project.
|
|
|
|
## Overview
|
|
|
|
The Authentication API is a secure and reliable solution for user authentication in web applications. It provides endpoints for user registration, login, and password reset.
|
|
|
|
## Features
|
|
|
|
- User registration: Allows users to create new accounts by providing their email address and password.
|
|
- User login: Allows users to authenticate themselves by providing their credentials.
|
|
- Password reset: Provides a mechanism for users to reset their passwords if they forget them.
|
|
|
|
## Installation
|
|
|
|
To install and run the Authentication API, follow these steps:
|
|
|
|
1. Clone the repository: `https://somegit.dev/libexi01/5.git`
|
|
2. Install dependencies: `v install`
|
|
3. Start the server: `v run src`
|
|
|
|
## Usage
|
|
|
|
Once the server is running, you can use the following endpoints:
|
|
|
|
- `POST /api/register`: Register a new user.
|
|
- `POST /api/login`: Authenticate a user.
|
|
- `POST /api/reset-password`: Reset a user's password.
|
|
- `GET /signup`: Register a new user through the Web UI.
|
|
- `GET /login`: Authenticate a new user through the Web UI.
|
|
|
|
For detailed API documentation, refer to the [API documentation](/libexi01/5/src/branch/main/docs/api.md).
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! If you would like to contribute to the Authentication API project, please follow the guidelines outlined in the [CONTRIBUTING.md](/docs/CONTRIBUTING.md) file. |