Code Monkey home page Code Monkey logo

ecap's Introduction

███████  ██████  █████  ██████
██      ██      ██   ██ ██   ██
█████   ██      ███████ ██████
██      ██      ██   ██ ██
███████  ██████ ██   ██ ██

super simple email capture service

alt Daemon alt Rust alt Binary alt Failed alt Passed alt Version

eCap

eCap is a super simple email capture web service. It is designed to validate an email and then simply insert into a postgresql database.

It's main intention is those looking to capture emails for newsletter subcribers and that are also using some kind of static site that does not have a backed API.

Features

  • Full email validation
  • API authentication via x-api-key header
  • Email de-duplication
  • Accepts CORS requests (tested under Firefox & Chrome)

Building

Make sure you have sqlx-cli installed so that you can manually run migrations to make sure that the database schema is in place. Otherwise compilations will fail :|

$ cargo install sqlx-cli
$ sqlx migrate run
$ cargo build

Environment Variables

Variable Description Example
DATABASE_URL Pg connection string postgres://dev:pass@localhost/ecap
API_KEY API Key for the service 1f726148-499f-4e5b-b164-1e76ff223af1
ECAP_PORT default is 8080 1337

Calling the API

$ curl \
        -X POST \
        -H "Content-Type: application/json" \
        -H "X-API-KEY: 63cad126-7373-45dd-a075-8687b148aeeb" \
        -d '{"email": "[email protected]"}' \
        localhost:8080/submit

API Responses

Status Code Body Description Example
200 string operation was succcessful "success"
400 string some validation error message "email is invalid"
500 string some server side issue "server error"

Version

0.1.0-ALPHA

Contributing

  1. Fork it (https://github.com/anharhussainmiah/ecap/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

ecap's People

Contributors

anharhussainmiah avatar dependabot[bot] 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.