AQARE is a Node.js-based backend application designed for an apartment rental platform. This project is part of my graduation requirements and includes features for user management, apartment listings, and more.
- User authentication (local and Google)
- CRUD operations for apartments and user management
- View count tracking for apartments
- Favorites functionality for users
- Password reset functionality
- Custom error handling
- Node.js (ES6)
- Express for web framework
- MySQL as the database
- Passport.js for authentication
- Docker and Docker Compose for containerization
- Git and GitHub for version control
- db-migrate for database migrations
-
Clone the repository:
git clone https://github.com/3qarat/Web-Backend.git cd Web-Backend/src/server -
Install dependencies:
npm install
-
Set up your MySQL database and update the configuration in
config.js. -
Run the migrations to set up the database:
npx db-migrate up
-
Start the application:
npm start
Once the application is running, you can access the API endpoints at http://localhost:PORT, where PORT is the port defined in your configuration (default is usually 3000).
You can find the API endpoints and their details in the Postman collection linked below:
Contributions are welcome! Please create a pull request or open an issue if you find any bugs or have suggestions for improvements.