Coin Track — Balance Tracker

Coin Track is a balance tracking application.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. Contact

About The Project

Coin Track is a balance tracker where the user enters the price, title, description, and date of the transaction. The details of the transaction are displayed on the application paged, as well as being stored in the database. This application has not been deployed.

Key Features

• Keeps track of balance through transactions
• Stores information inside a database so the user can access the information again

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

Install Node.JS at https://nodejs.org/en/download/current

• Install npm

  npm install npm@latest -g

Installation

1. Create a free MongoDB Cluster by following this video and save the URL: https://youtu.be/jXgJyuBeb_o?si=pAZKJtX1tzfMZBSj
2. Clone the repo

   git clone https://github.com/ErikTsai/coin-track

3. Install NPM packages

   npm install

4. Enter your MongoDB Cluster URL in api/.env

   MONGO_URL="ENTER URL HERE"

5. Navigate to the path of the api folder and run in your terminal

    nodemon index.js

6. In a separate terminal, start the React app

   npm start

7. To close the server and application by closing the terminals used to start the server and application

(back to top)

Roadmap

• Deploy Application
• Improve Current Styling
• Add Mobile Styling

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)

Contact

• LinkedIn: Erik Tsai
• Project Link: Coin Track

(back to top)