-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
60 lines (36 loc) · 1.88 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# CDAX
Welcome to the CDAX GitHub repository! CDAX is a specialist online money transmission service provider based in the Isle of Man, offering solutions for international currency exchange and treasury management.
## Repositories
### Platform Monorepo
The [CDAX Platform Monorepo](https://github.com/cdaxfx/cdax-platform) is the central repository for all platform-related components. It includes:
- Core services
- UI components
- Integration modules
- Deployment configurations
This monorepo is designed to streamline development and maintain consistency across the platform.
### API Repository
The [CDAX API Repository](https://github.com/cdaxfx/cdax-api) houses the APIs used by our platform. It provides:
- API documentation
- Endpoint definitions
- Authentication methods
- Usage examples
This repository is crucial for developers integrating with our services or building new features.
## Getting Started
To contribute or get involved with the CDAX platform, follow these steps:
1. **Clone the Repositories:**
```bash
git clone https://github.com/cdaxfx/platform.git
git clone https://github.com/cdaxfx/cdax-api.git
```
2. **Set Up Your Development Environment:**
Follow the setup instructions in the respective repositories to configure your local environment.
3. **Contribute:**
- For platform-related contributions, check out the [CDAX Platform Monorepo](https://github.com/cdaxfx/cdax-platform) issues and pull requests.
- For API-related contributions, refer to the [CDAX API Repository](https://github.com/cdaxfx/cdax-api).
4. **Provide Feedback:**
Share your feedback and suggestions by [emailing us](mailto:[email protected]).
## Community Resources
- [CDAXFX Documentation](https://docs.cdax.forex)
- [CDAXFX Discussions](https://github.com/cdaxfx/discussions)
## Contact Us
For any inquiries or support, please contact us at [[email protected]](mailto:[email protected]).