diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..c280bd3 --- /dev/null +++ b/.env.example @@ -0,0 +1,6 @@ +NEXT_PUBLIC_GRAPHQL_ENDPOINT= +NEXT_PUBLIC_BASE_URL= + +# Axiom +NEXT_PUBLIC_AXIOM_DATASET= +NEXT_PUBLIC_AXIOM_TOKEN= \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6d06dae --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing to Voodle + +I'm excited that you're interested in contributing to Voodle! +I wanted to create this small guide to help you get started with the contribution process. + +## How to Contribute + +1. Fork the repository on GitHub. +2. Clone your fork to your local machine. +3. Create a new branch for your feature or bug fix. +4. Make your changes and commit them with a clear message. +5. Push your changes to your fork on GitHub. +6. Open a pull request from your fork to the main Voodle frontend repository. + +## Code Style + +I use ESLint and Prettier to maintain code quality. Before submitting your changes, please run: + +```bash +pnpm run lint +``` + +## Reporting Bugs + +If you find a bug, please open an issue on GitHub. Include as much detail as possible: + +- Steps to reproduce the bug +- Expected behavior +- Actual behavior +- Any error messages or logs +- Browser and device information + +## Suggesting Enhancements + +I welcome suggestions for enhancements! Please open an issue on GitHub and describe your idea. + +## Pull Request Process + +1. Ensure your code follows the project's style guidelines. +2. Update the README.md with details of changes, if applicable. +3. Your pull request will be reviewed by the maintainers (AKA me), who may request changes or provide feedback. + +## Frontend-specific Guidelines + +- Use TypeScript for all new components and functions. +- Follow the existing component structure and naming conventions. +- Use Tailwind CSS for styling, adhering to the established design system. +- Ensure all new pages and components are responsive. +- Write unit tests for new components when applicable. + +## Questions? + +If you have any questions about contributing, feel free to open an issue for discussion. + +Thank you for contributing to Voodle! diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c61b663 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6bbd5d0 --- /dev/null +++ b/README.md @@ -0,0 +1,105 @@ +![BETA Badge](https://img.shields.io/badge/status-BETA-yellow) +![APACHE 2.0 License](https://img.shields.io/badge/license-APACHE%202.0-green.svg) +[![X Follow](https://img.shields.io/twitter/follow/JulienCoulaud?style=social)](https://twitter.com/JulienCoulaud) + +# Voodle: Crypto trading platform on TON blockchain (Frontend) + +This is the frontend repository for Voodle, a trading platform where users can create strategies to automatically buy and sell tokens on the TON blockchain, without the need for technical knowledge. + +## Disclaimer + +This is my first time open-sourcing a project, so I appreciate your patience as I work through any issues. Since I didn't originally plan to open-source this, the code could be better documented and cleaned up. Improvements are on the way! + +The frontend and backend are separated into two repositories: + +- [Frontend](https://github.com/jcoulaud/voodle-client) +- [Backend](https://github.com/jcoulaud/voodle-server) + +## ⚠️ Status: Working with known issues + +Voodle is still under active development and is not fully functional yet. Please use it **at your own risk**. + +### Some known issues + +- The frontend design needs to be improved. +- Some components may not be fully responsive. +- Error handling and user feedback could be enhanced. + +## Features + +- User authentication with magic link +- Strategy management interface +- Transaction history view +- Wallet integration +- Multi-DEX support (DeDust and StonFi) + +## Tech Stack + +- **Framework**: Next.js 14 +- **Styling**: Tailwind CSS with Tailwind UI components and Headless UI +- **State Management**: React Context API +- **API Communication**: Apollo Client (GraphQL) +- **Form Handling**: React Hook Form with Zod validation +- **Icons**: Lucide React + +## Getting Started + +### Prerequisites + +- Node.js (v18.17.1 or later) +- pnpm + +### Installation + +1. Clone the repository: + + ``` + git clone https://github.com/jcoulaud/voodle-client.git + cd voodle-client + ``` + +2. Install dependencies: + + ``` + pnpm install + ``` + +3. Set up environment variables: + + - Copy `.env.example` to `.env` and fill in the required values. + +4. Start the development server: + + ``` + pnpm run dev + ``` + +5. Open [http://localhost:3001](http://localhost:3001) with your browser to see the result. + +6. Start the backend: + + To run the backend application, please refer to the [Voodle Backend Repository](https://github.com/jcoulaud/voodle-server) for installation and setup instructions. + +## Project Structure + +- `src/`: + - `app/`: Next.js 14 app directory + - `(authenticated)/`: Routes that require authentication + - `auth/`: Authentication-related pages (login, verify) + - `components/`: Shared components used across multiple pages + - `lib/`: Utility functions, GraphQL queries/mutations, and configurations + - `providers/`: React context providers + - `styles/`: Global styles and Tailwind CSS configuration + - `components/`: Reusable React components + - `hooks/`: Custom React hooks + - `types/`: TypeScript type definitions + - `middleware.ts`: Next.js middleware for route protection and logging +- `public/`: Static assets (images, fonts, etc.) + +## Contributing + +Contributions are welcome! Please feel free to submit a Pull Request. + +## License + +This project is licensed under the [Apache 2.0 License](./LICENSE) - see the [LICENSE](./LICENSE) file for details. diff --git a/src/app/favicon.ico b/src/app/favicon.ico index 718d6fe..290f2fb 100644 Binary files a/src/app/favicon.ico and b/src/app/favicon.ico differ