A Cashu wallet designed for fast, easy onboarding and use
- Lightning Integration: Send and receive Lightning payments
- Cashu Ecash Wallet: Store balance locally as eCash
- Contacts: Add other users as contacts to send and receive eCash without copy/pasting tokens
- Profile Pages: Set a custom username and get eTips at boardwalkcash.com/username
- Conditional payments: Send locked eCash only unlockable by the contact you are sending to
- Notifications: Get notified when someone sends you eCash or adds you as a contact
- Transaction History: Keep track of your payment activities
- Cash Taps: One-tap shareable ecash for easy payments
- USD Tokens: eCash is denominated in USD
- Multiple Mints: Hold eCash in multiple mints at the same time
These instructions will help you set up a copy of the project on your local machine for development and testing purposes.
Before you begin, ensure you have the following tools installed:
- Docker
- Docker Compose
- Node.js (if running the Next.js app locally)
-
Fork and clone the repository:
git clone https://github.com/your-username/boardwalkcash.git
-
Navigate to the project directory:
cd boardwalkcash
-
Use Docker Compose to build and run the containers:
docker-compose up --build
Alternatively, if you prefer to run only the database with Docker and use your local Node.js environment for the Next.js app:
a. Start the database container:
docker-compose up db
b. Install dependencies:
npm install
c. Run the Next.js app:
npm run dev
-
Access the application at
http://localhost:3000
in your web browser.
We welcome contributions to Boardwalk Cash! Here's how you can contribute:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Project Link: https://github.com/makeprisms/boardwalkcash
- The Cashu Ecosystem
- Cashu-TS
- Calle
- Egge