Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.64 KB

README.md

File metadata and controls

60 lines (38 loc) · 2.64 KB
Raw

Project Name: Tiplink

The following description is going to be updated once the project is complete till then look for all the research and development related progress here at this Notion Page

Table of Content

Description

Tiplink is a decentralized application (dApp) designed to create and manage Solana crypto wallets. Users can sign up using their Google credentials, upon which a crypto wallet is automatically created and linked to their account. The application securely stores the user's public key, allowing seamless interaction with the Solana blockchain.

Features

  • User Registration with Google OAuth: Secure and easy registration using Google credentials.

  • Crypto Wallet Generation: Automatic creation of a Solana wallet for each registered user.

  • Public Key Management: Secure storage and retrieval of user public keys.

Technologies

  • Web-app: Next.js, TypeScript
  • Database: PostgreSQL, Prisma ORM
  • Authentication: Google OAuth via next-auth
  • Blockchain: Solana

Getting Started

To get started with the Tiplink, follow these steps:

  1. Clone the repository: git clone https://github.com/code100x/tiplink
  2. Install dependencies: npm install
  3. Start the application: npm run dev

Contributing

Contributions are welcome! If you'd like to contribute to the Tiplink project, please fork the repository and submit a pull request.

  • github/pull_request_template.md: Template for pull requests.
  • github/issue_template.md: Template for issues.

Note

Please take an updated pull from the dev branch, and request branches for further features or services we need to add, and make pull requests to the relevant branches, not the main branch itself

  • main - Stable branch
  • dev - Branch for all the developer changes (Where your code will reside before moving to production)
  • dev-backend- Branch for all developer changes in the backend
  • dev-backend/* - Branch for changes in specific features within the backend
  • dev-frontend - Branch for all developer changes in the frontend
  • dev-frontend/* - Branch for changes in specific features within the frontend

License

The Tiplink is licensed under the MIT License.