CryptoIndex
Table of Contents
About The Project
Creating and maintaining a cryptocurrency index should be simple, free and under the user's control. That is this project's mission. While being inspired by IndexMonkey ๐ต, this project emphasizes the creation of something users run themselves instead of relying on an external platforms.
This is a placeholder repo, meaning name and other aspects could change at anytime. Star this project or join our Telegram for future updates.
The project is currently in development. Will update once it is at a point ready for testing or use.
Built With
Getting Started
- Clone the repo
- From project directory run
docker-compose up --build
- Find Tor address in Tor logs
- Log in with user: [email protected] pass: test1234
- Flutter UI is at http://localhost:808/
Connecting to Tor:
- Tor browser
- Tor VPN such as Orbot, to use existing browsers
Prerequisites
TBD
Installation
TBD
Usage
TBD
Roadmap
See the open issues for known issues and discussion. See the projects page for planning and future features.
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- 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
License
Distributed under the GLP v3 License. See LICENSE
for more information.
Contact
Email: whlla - [email protected]
Project Link: https://github.com/whlla/CryptoIndex