Revise README with project details and instructions
Updated project name, added features, tech stack, installation instructions, learning objectives, future improvements, and license information.
This commit is contained in:
parent
31675ac70b
commit
b1960b2f35
1 changed files with 98 additions and 1 deletions
99
README.md
99
README.md
|
|
@ -1 +1,98 @@
|
||||||
# projet_php
|
# Folliow – Projet PHP
|
||||||
|
|
||||||
|
A platform for sharing portfolios and projects, designed as a mix between Behance and LinkedIn. Folliow focuses on highlighting real projects while making it easy to connect with other users.
|
||||||
|
|
||||||
|
This project was developed as part of the **DWWM (Développeur Web et Web Mobile)** training.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- User authentication and profile management
|
||||||
|
- Portfolio and project creation
|
||||||
|
- Project showcase with descriptions and technologies
|
||||||
|
- User connections / follow system
|
||||||
|
- Project feed and discovery
|
||||||
|
- Profile and project search
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Tech Stack
|
||||||
|
|
||||||
|
**Client:** HTML, CSS, JavaScript
|
||||||
|
**Server:** PHP (MVC architecture)
|
||||||
|
**Database:** MySQL
|
||||||
|
**Web Server:** Apache
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Project Structure
|
||||||
|
|
||||||
|
```text
|
||||||
|
folliow/
|
||||||
|
├── app/
|
||||||
|
│ ├── controllers/
|
||||||
|
│ ├── models/
|
||||||
|
│ └── views/
|
||||||
|
├── public/
|
||||||
|
│ ├── assets/
|
||||||
|
│ └── index.php
|
||||||
|
├── config/
|
||||||
|
│ └── database.php
|
||||||
|
├── sql/
|
||||||
|
│ └── folliow.sql
|
||||||
|
└── README.md
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Clone the project
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/Yasder5/projet_php.git
|
||||||
|
```
|
||||||
|
|
||||||
|
Go to the project directory
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd projet_php
|
||||||
|
```
|
||||||
|
|
||||||
|
Import the database
|
||||||
|
|
||||||
|
- Use the SQL file located in the `sql/` directory
|
||||||
|
|
||||||
|
Configure database access
|
||||||
|
|
||||||
|
- Update credentials in `config/database.php`
|
||||||
|
|
||||||
|
Run the project
|
||||||
|
|
||||||
|
- Use a local server (XAMPP, WAMP, or Apache on Linux)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Learning Objectives
|
||||||
|
|
||||||
|
- Build a complete PHP web application
|
||||||
|
- Apply MVC architecture
|
||||||
|
- Manage a relational database
|
||||||
|
- Design a user-oriented portfolio platform
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Future Improvements
|
||||||
|
|
||||||
|
- Private messaging
|
||||||
|
- Likes and comments on projects
|
||||||
|
- Tags and categories
|
||||||
|
- Improved responsive design
|
||||||
|
- Advanced authentication and roles
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is for educational purposes.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue