Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.52 KB

README.md

File metadata and controls

65 lines (40 loc) · 2.52 KB

dial-a-carol

Table of Contents

About this project

Dial a Christmas Carol - for Advent Calendar

Setting up the Project

  1. Go to the project repo and fork it by clicking "Fork"
  2. If you are working on Windows, download Git Bash for Windows to get a full Unix bash with Git functionality
  3. Clone the repo to your desktop git clone https://github.com/YOUR_USERNAME/dial-a-carol.git
  4. Open the project

Installation Guide

You need to have the following installed:

Python 3.x

  • Request - Use the following command in your terminal to install Request: pip install requests
  • Flask - Use the following command in your terminal to install Request: pip install Flask

You can download the libraries by using the pip command:

$ pip install Flask

$ pip install requests

Since the requirements.txt is included in the repo, you can simply execute the following command

$ pip install -r requirements.txt

This will download the required libraries for you.

Finally, run the code on your web server (you'll need to modify the code to include your server details) or run locally using Ngrok.

A much detailed overview can be found at this blog Dial a Christmas Carol with Nexmo and Python

Contributing

Thank you for taking the time to contribute, feel free to ask questions.

We love to receive contributions from the community and hear your opinions! We want to make contributing to dial-a-carol as easily as it can be.

To get started:

• Ensure you go through the README.md document so you can get familiar with the project.

• Check the Issues for open tickets.

• Create a pull request here. See this page for a guide on making pull request

License

This project is distributed under MIT License. See License for more information.