CareCast is self-care and enrichment web application featuring a soothing, mobile first design. My motivation to create this app stems from my experiences learning to level up my self-care skills, particularly in regard to Emotional Granularity. You can read more about Emotional Granularity at this Wikipedia page and this Psychology Today article.
The backend of the application leverages Ruby on Rails API functionality to receive and send AJAX requests in a JSON format. The interactive frontend is built with ReactJS and styled with React Bootstrap for a responsive design.
Currently, users of CareCast can:
-
Track self-care activities:
- Hours of sleep
- Glasses of water
-
Rate themselves on how they feel about their:
- Energy
- Productivity
- Motivation
- Stress
-
Keep a daily Journal and Todo List
-
Chose from a list of over 200 granular feelings, group by categories of parent feelings, based on a users' needs being "met" or "unmet."
-
View visualizations of their inputed data.
-
Recieve inspirational quotes on a daily basis.
Refer to the README in the carecast_frontend repository for instructions to set up the frontend interface and ReactJS
- Developed on Google Chrome (80.0.3987.149)
- Ruby (v2.6.1)
- RAILS (v6.0.2.2)
- Bundler (v2.1.4)
- PostgreSQL (v12.3)
For this guide, a MacOSX environment is assumed.
If you have the above dependencies:
- Fork and clone this repository to your desired install directory.
- Navigate to that directory and open it in your code editor
- In your terminal, run
bundle installto install all required ruby gem packages.
If you don't have the above dependencies:
- Install Ruby Version Manager for easy installing/updating of Ruby 2.6.1
- Install Bundler to manage your Ruby gems
- To install Rails, run
gem install rails -v 6.0.2.2rbenv rehashandrails -vto confirm. - Install PostgreSQL.
- Follow the first set of instructions above.
This repo requires hosting locally. To start hosting the local server, start by opening PostgreSQL and starting the server (the elephant should appear in your menu bar). Then, in your terminal navigate to the directory you've installed this repo in. Once there, execute in order:
rails db:createrails db:migraterails db:seed- You should seed 'Database Seeded! in your terminal.
rails s.
The rails server is functioning solely as a backend API for local development, so you do not need to navigate to localhost:3000 in your browser unless you'd like to test to make sure the database is running correctly. It's recommended to run the backend on port 3000 first, then the frontend on a different port.
MIT License
Copyright (c) 2020 Joshua Mclean
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.