Welcome to Ramp API 👋

This api is also hosted on https://ramp-api.onrender.com/

API Documentation is located at https://documenter.getpostman.com/view/1825277/2s8YYMo1KG

DEPLOYING

🏠 Requirements

• node 16.18 and above
• NPM or Yarn
• MongoDB database

Setting up and Running the API

✨ [Clone](Clone the repo)

  git clone https://github.com/Mangweli/RampAPI.git
  cd RampAPI

✨ [Dependancies](Install Dependancies)

  npm install or yarn

✨ [env](Environment Variables)

Copy .env.example to .env

  cp .env.example .env 

edit .env file and enter your environment variables

Run tests

npm test

DEPLOYING WITH DOCKER

🏠 Requirements

Docker Installed on your machine or server

Setting up and Running the API

✨ [Clone](Clone the repo)

  git clone  https://github.com/Mangweli/RampAPI.git
  cd RampAPI

✨ [Dependancies](Install Dependancies)

  npm install or yarn

✨ [env](Environment Variables)

Copy .env.example to .env

  cp .env.example .env 

• Edit .env file and enter your environment variables
• Make sure DB_HOST is changed to mysql

Run Tests

docker-compose exec -T app npm test

Running the App

npm start

The app will be live on the port entered on the .env file

This can be accessed through any browsers or any api simulation app

Author

👤 Kingsley

• Website: Author Website Here
• Twitter: @Kmangwels
• Github: @Mangweli
• LinkedIn: [@Kingsley Amaitsa](https://linkedin.com/in/Kingsley Amaitsa)

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Kingsley.

---

This README was generated with ❤️ by readme-md-generator