README

README.md

@@ -1,16 +1,58 @@
-# swifty
+# 42 API Client Flutter App
 
-42
+A clean and responsive Flutter app to look up 42 school students by their login, fetch their profile data via the 42 API, and display detailed info such as skills and projects.
+
+---
+
+## Features
+
+- Home screen with a beautiful background image and a user input field.
+- Fetch profile data by login with token-based API calls.
+- Display profile details including avatar, level, correction points, and location.
+- Tab view for Skills and Projects, each presented in a neat, scrollable list.
+- User-friendly error handling with a friendly message and return button.
+
+---
+
+## Screenshots
+
+### Home Screen
+
+![Home Screen](./assets/screenshots/home_screen.png)
+
+### Profile Screen (Skills Tab)
+
+![Profile Skills](./assets/screenshots/profile_skills.png)
+
+---
 
 ## Getting Started
 
-This project is a starting point for a Flutter application.
+### Prerequisites
 
-A few resources to get you started if this is your first Flutter project:
+- Flutter SDK installed ([Installation Guide](https://flutter.dev/docs/get-started/install))
+- A valid 42 API token
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
+### Installation
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
 
-For help getting started with Flutter development, view the
+1. Clone the repository:
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
+
-samples, guidance on mobile development, and a full API reference.
+```bash
+git clone <your-repo-url>
+cd your-project-folder
+```
+
+2. Install dependencies:
+```bash
+flutter pub get
+```
+
+3. Add your 42 API Credentials in a .env file at the root of the project as:
+```bash
+CLIENT-ID="YOUR CLIENT ID"
+CLIENT-SECRET="YOUR CLIENT SECRET"
+```
+4. Run the app:
+```bash
+flutter run
+```