Skip to content

whlla/CryptoIndex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CryptoIndex

Contributors Issues GPL License Telegram Chat

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

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

  1. Clone the repo
  2. From project directory run docker-compose up --build
  3. Find Tor address in Tor logs
  4. Log in with user: email@gmail.com pass: test1234
  5. 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.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GLP v3 License. See LICENSE for more information.

Contact

Email: whlla - whla@pm.me

Project Link: https://github.com/whlla/CryptoIndex

Acknowledgements