vanshchauhan21 / CryptoTracker

https://crypto-tracker-kappa-ebon.vercel.app
MIT License
12 stars 48 forks source link

πŸ’°CryptoTracker

This project was created by @vanshchauhan.

πŸ“Š Description

CryptoTracker is a web application that allows users to track and monitor cryptocurrency prices in real-time. With a user-friendly interface, users can easily access current market trends and make informed decisions about their investments.

πŸ“ˆ GitHub Repository Stats

🌟 Stars 🍴 Forks πŸ› Issues πŸ”” Open PRs πŸ”• Closed PRs πŸ› οΈ Languages βœ… Contributors
GitHub stars forks issues pull requests Closed PRs Languages Contributors

πŸ› οΈ Tech Stack & Technologies Used

Table of Contents

  1. Project Overview
  2. Tech Stack
  3. Features
  4. Getting Started
  5. Running Locally
  6. Contributing
  7. GitHub Repository Stats
  8. License
  9. Connect with Us
  10. Contributors
  11. Stargazers and Forkers
  12. Back to Top

✨ Features

πŸš€ How to Contribute to This Project

We’re excited to have you contribute to this Ice Cream Parlour Website project! Follow these simple steps to get started:

  1. 🍴 Fork the Repository

    • Go to the [repository page].
    • Click the Fork button (top right). This creates a copy of the project in your GitHub account.
  2. πŸ’» Clone Your Fork

    • Once the repository is forked, clone it to your local machine. Open your terminal and run:
      
      git clone
    
    
    - Replace your-username with your GitHub username.
  3. 🌿 Create a New Branch

    • Before making any changes, create a new branch for your work:

      git checkout
      -b your-branch-name
    • Choose a branch name that describes what you're working on, such as fix-navbar or add-contact-form.

  4. πŸ› οΈ Make Your Changes

    • Open the project files in your code editor (e.g., VS Code) and make your changes.
    • You can contact the project manager for any queries you have.
  5. βœ… Test Your Changes

    • Make sure your changes work correctly by testing the website locally. Run the app using:
      npm start

      This will launch the app in development mode. Open http://localhost:3000 to view your changes.

  6. πŸ’¬ Commit Your Changes

    • Once your changes are ready, add them to staging and commit them with a descriptive message:
      git add .
      git commit -m "Added feature X or Fixed issue Y"
  7. πŸ“€ Push Your Changes

    • Push your changes to your forked repository on GitHub:
      git push origin feature-YourFeature
  8. πŸ”„ Create a Pull Request (PR)

    • Go back to the original repository on GitHub.
    • Click the Compare & pull request button.
    • Write a short description of your changes and submit the pull request.
  9. πŸ”Ž Review Changes

    • The project manager will review your PR. If your changes are approved, your request will be merged.

Getting Started with our CryptoTracker!!

Prerequisites

Make sure you have the following installed on your machine:

Installation

  1. Clone the repository:

    
    git clone https://github.com/your-username/CryptoTracker.git
  2. Navigate to the project directory:

    cd CryptoTracker
  3. Copy the environment variables template and add your Clerk publishable key:

    cp .env.sample .env.local
  4. Install the dependencies:

    npm install

Available Scripts: In the project directory, you can run:

npm start

Runs the app in development mode. Open http://localhost:3000 to view it in your browser. The page will reload when you make changes.

npm run build

Builds the app for production to the build folder.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

And there you have it!

Congratulations!

You've now mastered the art of cryptocurrency tracking. If only making money were this easy. Good luck, and may your portfolio be as impressive as your coding skills!

πŸ’— Contributors

🌟 Stargazers

[![Stargazers repo roster for @vanshchauhan21/CryptoTracker](https://reporoster.com/stars/dark/vanshchauhan21/CryptoTracker)](https://github.com/vanshchauhan21/CryptoTracker/stargazers)

❀️ Forkers

Forkers repo roster for @vanshchauhan21/CryptoTracker

🀝 Connect with Us

Thank you for exploring this project! We’d love to connect and hear from you. Reach out through any of the platforms below:

LinkedIn Twitter GitHub

πŸ“„ License

This project is licensed under the MIT License

Back to Top