1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# StuDirect - API
StuDirect is a Tinder-like web application that matches students and companies for the Career Launch.
The application was developed as part of the programming project and offers a pleasant user experience, modern technologies and features such as swiping, chatting and profiles.
---
## Features
- Swipe functionality to match students and companies
- Real-time chat between matched parties
- Student profiles with interests, field of study and a CV
- Company profiles with internships, job openings, location and general information
- Admin panel for managing students, companies and logs
- Email verification and password reset
- Skill matching between students and companies
- RESTful API, JSON responses, rate limiting
- Separate versions for mobile, desktop and admin
---
## Tech Stack
- Laravel (PHP framework)
- Laravel Sanctum (API authentication & RBAC)
- Eloquent ORM
- PHPUnit
- MySQL database
- Mailtrap (email testing)
- RESTful API, JSON
- CI via GitHub Actions
---
## Installation
1. **Clone the repository**
```bash
git clone https://github.com/nasrlol/studirect-api
cd studirect-api/source
```
2. **Install the Composer dependencies**
```bash
composer install
```
3. **Configure .env**
```bash
cp .env.example .env
```
Fill in your database credentials, Mailtrap settings and other environment variables in `.env`.
4. **Generate the app key**
```bash
php artisan key:generate
```
5. **Migrate and seed the database**
```bash
php artisan migrate:fresh --seed
```
6. **Start the server**
```bash
php artisan serve
```
---
## Using the API
See the [API documentation](./API-ROUTES.md) for all endpoints, authentication and usage examples.
- **Authentication:** via Laravel Sanctum tokens (Bearer); log in via `/api/students/login`, `/api/companies/login` or `/api/admins/login`
- **Rate limiting:** 300/min (default), 500/min for intensive endpoints (appointments, connections, skills)
- **All responses are JSON**
- **See [routes/api.php](./source/routes/api.php)** for the complete overview and current endpoints.
---
## Running the tests
```bash
php artisan test
```
---
## Main Directories
- `/source/app/Http/Controllers/Api/` – all API controllers
- `/source/routes/api.php` – API routes
- `/source/app/Models/` – model logic
- `/source/database/seeders/` – seeder data for test accounts
---
## Security & Best Practices
- Input validation, CSRF, XSS and SQL injection prevention, RBAC via policies/gates
- Rate limiting on all routes
---
## Learn more
- [API documentation](./docs/api.md)
- [Project documentation (wiki)](../../wiki)
---
© 2025 StuDirect — The API for the Career Launch.
|
