Coinance

A MERNG Stack application that allows users to add any crypto currencies to their personal dashboard.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Coinance is a coin tracking application for all those crypto enthusiasts out there to manage and assess their coins or for new users to gain knowledge and understanding of the prices of the coins. Almost all coins are listed in the application for users to assess and add to their dashboard, with live price and market coverage from efficient API’s providers such as Coin-gecko.

Mock Up

(back to top)

Built With

The following dependencies, frameworks, libraries, plugins are implemented into the application which allow it to execute the functionalities and purposes it was designed for.

• Mongo
• Express
• React
• Node
• GraphQL
• Apollo
• JWT
• Postcss
• Tailwind
• Autoprefixer
• Coingecko

(back to top)

Getting Started

Clone the repository and install the npm packages

Prerequisites

None at this stage

Installation

1. Clone the repo

   git clone https://github.com/gurtej154/Coinance.git

2. Install NPM packages

   npm install

(back to top)

Usage

To ulitise this application, the following need to be installed and implemented in the command line.

• Npm init - for node packages
• Npm install - for multiple packages
• Npm run build - To develop the front-end
• Npm start - to initialize the back-end

(back to top)

Roadmap

• Constantly updating to current standards

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Gurtej Singh - gurtej154

Project Link: Repository

(back to top)

Acknowledgments

• N/A

(back to top)