/chewiepay

A payment web application, built with Elixir

Primary LanguageElixirMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn


Chewiepay

An API to manage a payment system!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

About The Project

An API to manage a payment system!

Features:

  • Deposit money on an account
  • Withdrawal money of an account
  • Transfer money between accounts

Built With

Getting Started

Prerequisites

  • elixir 
    npm install npm@latest -g

Installation

  1. Clone the repo 
    git clone https://github.com/jennifertakagi/chewiepay.git
  2. Install dependencies
mix deps.get
  1. Create a docker image of Postgres following the command
docker run --name chewieapi_dev -e POSTGRES_PASSWORD=postgres -p 5432:5432 -d postgres
  1. Run database migrations
mix ecto.setup
  1. Run the following command in order to start the application in a development environment:
mix phx.server

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

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

Contact

Jennifer Takagi - @jennitakagi