|
| 1 | +# Modern Auth Portal |
| 2 | + |
| 3 | +This project is a front-end application for a simple authentication system. It provides user-friendly interfaces for **Sign Up**, **Sign In**, and **Profile Management**. The app is styled with modern design principles and interacts with an in-memory backend API. |
| 4 | + |
| 5 | +## Features |
| 6 | +- **Sign Up**: Create a new account. |
| 7 | +- **Sign In**: Log in and receive a token. |
| 8 | +- **Profile Management**: View user information after authentication. |
| 9 | +- **Responsive Design**: Optimized for both desktop and mobile devices. |
| 10 | +- **Notification System**: Success and error notifications for user actions. |
| 11 | + |
| 12 | +## Live Demo |
| 13 | +- **Frontend**: [https://tridibs-in-memory-authentication.netlify.app](https://tridibs-in-memory-authentication.netlify.app) |
| 14 | +- **Backend API**: [https://tridibs-in-memory-authentication-api.onrender.com](https://tridibs-in-memory-authentication-api.onrender.com) |
| 15 | + |
| 16 | +## Installation and Setup |
| 17 | + |
| 18 | +### 1. Clone the Repository |
| 19 | +```bash |
| 20 | +git clone https://github.com/Tridib11/Authentcation-UI.git |
| 21 | +``` |
| 22 | + |
| 23 | +### 2. Open the Project |
| 24 | +Simply open the `index.html` file in your preferred browser to view the app locally. |
| 25 | + |
| 26 | +### 3. Backend API |
| 27 | +Make sure the backend API is running and accessible at [https://tridibs-in-memory-authentication-api.onrender.com](https://tridibs-in-memory-authentication-api.onrender.com). |
| 28 | +For backend details, visit the [Backend GitHub Repository](https://github.com/Tridib11/Authentication-api). |
| 29 | + |
| 30 | +## Project Structure |
| 31 | +``` |
| 32 | +. |
| 33 | +├── index.html # Main HTML file |
| 34 | +├── style.css # Embedded in <style> tags |
| 35 | +├── README.md # Documentation |
| 36 | +``` |
| 37 | + |
| 38 | +## How It Works |
| 39 | + |
| 40 | +### 1. Sign Up |
| 41 | +- Allows users to create an account by providing a username and password. |
| 42 | +- Sends a `POST` request to `/signup`. |
| 43 | + |
| 44 | +### 2. Sign In |
| 45 | +- Authenticates users and retrieves a JWT token. |
| 46 | +- Sends a `POST` request to `/signin`. |
| 47 | + |
| 48 | +### 3. Profile Management |
| 49 | +- Fetches user details using the JWT token. |
| 50 | +- Sends a `GET` request to `/me`. |
| 51 | + |
| 52 | +### 4. Logout |
| 53 | +- Clears the JWT token and returns to the Sign In page. |
| 54 | + |
| 55 | +## Technologies Used |
| 56 | +- **HTML5**: Structure and layout. |
| 57 | +- **CSS3**: Styling and responsive design. |
| 58 | +- **JavaScript**: Client-side logic and API interactions. |
| 59 | +- **Axios**: HTTP requests to the backend API. |
| 60 | +- **LocalStorage**: Stores the JWT token for authenticated sessions. |
| 61 | + |
| 62 | +## Notifications |
| 63 | +The app includes a built-in notification system to inform users about the success or failure of their actions, such as: |
| 64 | +- Successful sign-up or sign-in |
| 65 | +- Errors during API calls |
| 66 | +- Profile fetching issues |
| 67 | + |
| 68 | +## Screens |
| 69 | +- **Sign In** |
| 70 | +  |
| 71 | +  |
| 72 | + |
| 73 | +- **Sign Up** |
| 74 | +  |
| 75 | +  |
| 76 | + |
| 77 | +- **Profile** |
| 78 | +  |
| 79 | +  |
| 80 | + |
| 81 | +## License |
| 82 | +This project is open-source and available under the MIT License. |
| 83 | + |
| 84 | +## Author |
| 85 | +**Tridib** |
| 86 | +[GitHub](https://github.com/Tridib11) |
0 commit comments