Skip to content

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Personal API

A RESTful API built with Node.js and Express.js that showcases my skills, projects, and contact information.

🚀 Features

  • About Me: Get information about my background and experience
  • Skills: View my technical, learning, and soft skills with category filtering
  • Projects: Browse my projects with search and status filtering
  • Project Details: Get detailed information about specific projects
  • Contact: Access my contact information and social links

🛠️ Tech Stack

  • Node.js - Runtime environment
  • Express.js - Web framework
  • JavaScript - Programming language

📦 Installation

  1. Clone the repository:
git clone https://github.com/asadghouri/personal-api.git
cd personal-api
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev

The server will run on http://localhost:3000

📚 API Endpoints

Get All Endpoints

GET /

About Me

GET /about

Skills

GET /skills
GET /skills?category=technical
GET /skills?category=learning
GET /skills?category=soft

Projects

GET /projects
GET /projects?search=api
GET /projects?status=completed
GET /projects?search=todo&status=planned
GET /projects/:id

Contact

GET /contact

📝 Example Response

GET /projects/1

{
  "id": 1,
  "name": "Personal API",
  "description": "A REST API showcasing my information and skills",
  "techStack": ["Node.js", "Express.js"],
  "status": "In Progress",
  "githubUrl": "https://github.com/asadghouri/personal-api"
}

🧪 Testing

You can test the API using:

  • Your browser for GET requests
  • curl commands
  • Postman
  • VS Code REST Client extension

Example curl command:

curl http://localhost:3000/projects

📜 Available Scripts

  • npm start - Start the production server
  • npm run dev - Start the development server with nodemon

🤝 Connect With Me

📄 License

This project is open source and available under the MIT License.

🎯 Next Steps

  • Add MongoDB database integration
  • Implement authentication
  • Add input validation with express-validator
  • Deploy to production
  • Add API documentation with Swagger

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages