8000 GitHub - 7ossam7atem1/Deyarak: Your Dream Home Awaits!
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

7ossam7atem1/Deyarak

Repository files navigation

Deyarak

Deyarak (My graduation Project) is a Node.js webserver designed for the real estate industry, facilitating the renting of properties directly between owners and renters.

Authors

License

MIT MIT License

Tech Stack

  • Node.js (Runtime environment)
  • JavaScript (Development language)
  • MVC (Design pattern)
  • Express.js (Backend framework)
  • JWT (Authentication)
  • bcryptjs (Password hashing)
  • MongoDB (Database management system)
  • Cloudinairy (Image storage)
  • Sendgrid (Email notifications)
  • Mailtrap (Testing email service in Development)
  • Stripe (Payment service)
  • Swagger (APIs documentation)
  • Jasmine.js , supertest (Testing)

Architecture Overview

App Screenshot

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

NODE_ENV

PORT

DATABASE

DATABASE_PASSWORD

JWT_SECRET

JWT_EXPIRES_IN

JWT_COOKIE_EXPIRES_IN

EMAIL_USERNAME

EMAIL_PASSWORD

EMAIL_HOST

EMAIL_PORT

EMAIL_FROM

SENDGRID_USERNAME

SENDGRID_PASSWORD

STRIPE_SECRET_KEY

CLOUD_NAME

CLOUD_API_KEY

CLOUD_API_SECRET

setup & installation

  • Clone the Repository:
git clone https://github.com/7ossam7atem1/Deyarak.git
cd Deyarak
  • Install Dependencies
  npm install
  • run server
  npm start

Running Tests

To run tests, run the following command

  npx jasmine

Deployment

To run this project in production env run

  npm run start:prod
  • Render for Deployment

App Screenshot

Acknowledgements

  • Supervised by: Prof/Dr.Mahmoud Hussien

API Reference

https://deyarak-app.onrender.com/api-docs/

0