Giter Site home page Giter Site logo

btc-api's Introduction

Bitcoin API & Mailing

Get current bitcoin price straight to your inbox!

Prerequirements

To run this project yourself you need to install Docker and Docker Compose.

Installation tutorials listed below.

Step 1: Create .env file in root directory

Use .env.example as a refference.

You can leave SMTP settings empty but you won't be able to send any emails.

VERSION=1.0.0
HOSTNAME=localhost
DB_PATH=db
EMAILS_FN=subscribers.txt
PORT=8000
SMTP_HOST=_YOUR_SMTP_HOST
SMTP_PORT=_YOUR_SMTP_PORT_
SMTP_SECURE=_SECURE_true/false_
SMTP_USER=_SMTP_USER_EMAIL_
SMTP_PASS=_SMTP_USER_PASSWORD_

Step 2: Build and Run Application

>> docker-compose up --build -d

Done! Now API is Up & Running.

Step 3: Learn more about API using Swagger UI

๐Ÿ”— http://localhost:8000/docs

Once you're done with it, don't forget to turn everthing off.

Step 4: Stop & Remove Containers

List of subscribers will not be deleted.

>> docker-compose down

btc-api's People

Contributors

vladmosiychuk avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.