← api endpoint summary | how to get started with the dividend tracker api | dividend tracker api documentation
How-To Get Started with the Dividend Tracker API
Scenario
You want to get your local environment ready so that you can start using the Dividend Tracker API.
Prerequisites
Before you begin, make sure you have:
- A basic working knowledge of JavaScript or Node.js
- A New or Existing GitHub Repository Account
Steps
Fork the repository
- Log into GitHub with your username.
- Go to https://github.com/celesteg1/dividend-tracker-api in your browser.
- Click on the "Fork" button to create your own copy of the repository.
- GitHub creates a copy of the repository under your account:
https://github.com/your-username/dividend-tracker-api
Clone the forked repository
Use the git clone command to clone the forked repository. This will create a local copy on your machine.
git clone https://github.com/your-username/dividend-tracker-api.git
cd dividend-tracker-api
Install Node.js and npm
See the official Node.js website for instructions on how to install Node.js and npm.
Note
When you install Node.js, it automatically installs npm (Node Package Manager).
Install dependencies
Use npm install to install all required packages listed in package.json.
npm install