Dory

API for Dory App

Give a star ⭐ if you like it ❤️

🔗 Live • 🐛 Report Bug or Request Feature • ✨Postman Doc

Table of Contents 📋

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License
• Authors

About The Project 👀

An API for Dory App , Dory is an Online Medical Booking App It allows the patient to book appointments , search for doctors and labs , chat with Doctors and Request Home consultations or Home tests .

Built With 🔨

• Node.js
• Express
• Socket.IO
• MongoDB

Getting Started 🚀

To get a local copy up and running follow these simple example steps.

Prerequisites 💻

• Node (Download here!)

Installation ⬇️

1. Fork this repository 🍴

2. Clone your forked repository to your local system 👥

git clone https://github.com/<your-username>/doryapi.git

Or Download and extract the zip file.

Environmental Variables

You need to make your own config\config.env with the following structure.

 NODE_ENV=development
 PORT=5000
 MONGO_URI=mongodb://localhost:27017/YourCollection
 GEOCODER_PROVIDER=mapquest
 GEOCODER_API_KEY=0000
 FILE_UPLOAD_PATH= ./public/uploads
 MAX_FILE_UPLOAD=1000000
 JWT_SECRET=0000000
 JWT_EXPIRE=30d
 JWT_COOKIE_EXPIRE=30
 SMTP_HOST=smtp.mailtrap.io
 SMTP_PORT=2525
 SMTP_EMAIL=000000
 SMTP_PASSWORD=0000000
 [email protected]
 FROM_NAME=doryTeam
 FACEBOOK_ID=00000000
 FACEBOOK_SECRET=000000000
 GOOGLE_ID=000000000
 GOOGLE_SECRET=000000000

• NODE_ENV: It should be "production" in order to run the api on production otherwise use "development"
• PORT: Your api hosting port
• MONGO_URI: Your database path

  Eg: "mongodb://localhost:27017/YourCollection" If you're hosting on your localhost server.

• JWT_SECRET: Your json web token secret key.
• JWT_EXPIRE: The period token can last before expiring expressed in seconds or a string describing a time span

  Eg: 60, "2 days", "10h", "7d". A numeric value is interpreted as a seconds count. If you use a string be sure you provide the time units (days, hours, etc), otherwise milliseconds unit is used by default ("120" is equal to "120ms").

• FACEBOOK_ID and FACEBOOK_SECRET: Are used for signing up with facebook.
• GOOGLE_ID and GOOGLE_SECRET: Are used for signing up with google.
• SMTP_HOST: The provider for sending emails
• SMTP_EMAIL and SMTP_PASSWORD: The email and password key for sending emails through mailtrap.io

Running

1. Install NPM packages ⬇️

npm install

2. Run! 🏃‍♂️

npm start

Contributing 🤝

Any contributions you make are greatly appreciated.

1. Create your Branch (git checkout -b master/test-branch)
2. Commit your Changes (git commit -m 'Add some code')
3. Push to the Branch (git push origin master/test-branch)
4. Open a Pull Request

License 📝

Distributed under the MIT License. See LICENSE for more information.

Authors 📕

• Mohaned Ashraf