The PawKeeper API manages the data flow for the PawKeeper Application, providing endpoints for user management, pet information, and reviews.
- User authentication and management
- Pet information management
- Review system
- Real-time features using Socket.IO
- Comprehensive API documentation using Swagger
- Backend: Node.js, Express
- Database: MongoDB (mongoose)
- Authentication: JWT, bcrypt
- Real-time: Socket.IO
- Documentation: Swagger UI
- Security: Helmet, rate limiting
-
Clone the repository
-
Install dependencies:
npm install
Create a .env file with required environment variables Configuration Required environment variables:
MONGODB_URI: MongoDB connection string JWT_SECRET: Secret key for JWT authentication PORT: Server port (default: 5005) Running the Application Development mode: npm run dev Production mode: npm start API Documentation The API documentation is available at:
Local: http://localhost:5005/pawkeeper/api-docs Production: https://pawkeeper-lhk-be.onrender.com/api-docs Deployment The API is deployed on Render and can be accessed at: https://pawkeeper-lhk-be.onrender.com/
Contributors Hernâni Silva Kateryna Salata Luke Farrel