libexi01/5
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

37

Browse Source
This commit is contained in:
libexi01
2024-07-02 15:34:12 +05:30
parent 79c858a7c7
commit 8f2c51ac5c
1 changed files with 36 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
readme.md
View File

@@ -1,14 +1,37 @@
# Authentication API # Authentication API
This is a RESTful authentication API built using VLang on the back-end and HTML5, CSS3 on the front-end. The following endpoints are available:
- `POST /signup` - creates a new user account This is a README file for the Authentication API project.
- `POST /login` - logs in an existing user
## Prerequisites ## Overview
Before getting started, make sure you have installed:
- [V](https://vlang.io) 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.
- A modern web browser (Chrome, Firefox, Safari)
- [SQLite3](https://sqlite.org) ## Features
## Getting Started
1. Clone this repository to your local machine - User registration: Allows users to create new accounts by providing their email address and password.
2. Run `v run src` from the project root directory - User login: Allows users to authenticate themselves by providing their credentials.
3. Open http://localhost:8082 in your web browser - Password reset: Provides a mechanism for users to reset their passwords if they forget them.
4. Use the `/signup` endpoint to register a new user or the `/login` endpoint to authenticate as an existing user
## 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](/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.