README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 [Coin Wallet]

Coin Wallet is a simple web application that allows users to create a wallet and it is built using Ruby on Rails and PostgreSQL. It is deployed on fly.io and uses devise for authentication and allowing the users to create an account, add commodities and transactions in their accounts.

🛠 Built With

Tech Stack

Client

• Embedded Ruby

Server

• Rails

Database

• PostgreSQL

Key Features

• [User Authentication]
• [Add/Display Category]
• [Add/Display Transaction]

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:myaccount/my-project.git

Install

Install this project with:

  cd my-project
  gem install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  bin/rails test test/models/

Video

Video Link

Deployment

You can deploy this project using:

(back to top)

👥 Author

👤 OmarMWarraich

• GitHub: @OmarMWarraich
• Twitter: @omarwarraich1
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [Pagination]
• [OmniAuth and Stripe Integration]
• [Web3 Integration]
• [Bar Code Scanner]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it a ⭐️!.

(back to top)

🙏 Acknowledgments

I would like to thank the following.

• Gregoire Vella on Behance for the Original Design Idea.
• Any body who shall read and review my code.

(back to top)

❓ FAQ

• [Is this app Open Source?]

  • [Please check the license.]

• [How to use this app?]

  • [Please check the usage section.]

(back to top)

📝 License

This project is MIT licensed.

(back to top)