HomeDash is a React SPA with a Rails API backend intended to replace a current users desktop browser home page. This app was designed to centralize the data I would seek out across multiple sources on a daily basis as well as allowing me to track my current To-do list.
- Weather Data - AccuWeather
- News Data - NewsAPI
- Media Data - TheMovieDB
These instructions will get a local copy of HomeDash up and running on your machine.
You will need to acquire your own API keys from the APIs listed prior and create custom environment variables for those keys in your .env file in the root directory of the frontend repo.
REACT_APP_THE_MOVIE_DB_API_KEY = "API key"
REACT_APP_WEATHER_API_KEY = "API key"
REACT_APP_NEWS_API_KEY = "API key"
Fork and clone the Frontend Repo and the Backend Repo to your local machine.
Change directories into the backend local directory. Run bundle install to install dependencies. Ensure PostgreSQL is running on your machine, create and migrate the database.
$cd daily-dash-api
$bundle install
$rails db:create
$rails db:migrate
Run the following command to start your local server. The backend api will run on port:3001 locally, if 3001 is not used you will have to adjust the URLs used in the API calls on the frontend.
$rails s -p 3001
Change directories into the frontend local directory and run the following command to launch the app.
$cd daily-dash
$ npm start
Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.