Skip to content

thierbig/shtfolio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Shtfolio: Trending Shitcoin Tracker

Overview

Shtfolio is a comprehensive web application designed to track all the trending shitcoins in the cryptocurrency market. The application is built using React for the frontend and Node.js for the backend, providing a seamless and efficient user experience.


Table of Contents


Prerequisites

  • MongoDB 5.0 instance up and running

Installation

App Setup

  1. Clone the repository to your local machine.
    git clone https://github.com/thierbig/shtfolio.git
  2. Navigate to the app directory.
    cd shtfolio/app
  3. Install the required packages.
    yarn install
  4. Start the application.
    yarn run start
    • Alternatively, you can build the application.
    yarn run build

API Setup

  1. Navigate to the API directory.
    cd shtfolio/api
  2. Install the required packages.
    npm install
  3. Start the API server.
    node ./www/bin

Usage

Upon the first run of the API, the coin data will automatically be generated and stored in the MongoDB database. You can now use the Shtfolio web application to track all the trending shitcoins.


Contributing

If you would like to contribute to the project, please fork the repository and submit a pull request.


License

This project is licensed under the MIT License. See the LICENSE file for details.


For more information, please contact the maintainers.

About

Altcoins portfolio

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages