cyrus-kiprop / rails-react-health-app

Health app curated using Rails apis and React-redux front-end. With the api endpoints, users can keep track of their fitness leves.

Health App API

A simple health api app.
Report Bug · Request Feature

Table of Contents

• About the Project
  • Api Documentation
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

A progressive Health Tracking mobile web app. User can utilize the apps' exposed api utility to view and keep track of their fitness levels.

Api Documentation

Click here for api documentation.

Built With

The project was built using the following languages stacks:

Back-End(server)

• Ruby -v 2.7.1
• Ruby on Rails -v 5.2+

Testing Frameworks

• shoulda_matchers
• RSpec
• Factories gem

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Ruby -v 2.7.1 -click here

• Rails -v 5.2.4+

gem install rails -v 5.2.4

• Postgresql database click here

Installation

1. Clone the repo

git clone https://github.com/Cyrus-Kiprop/rails-react-health-app.git

2. CD into the project root directory

cd ./rails-react-health-app

3. Install Dependencies and gems

bundle install

4. Set the databases

rails db:create

5. Create database schemas

rails db:migrate

6. Seed the DB

 rails db:seed

7. Run rspec tests

bundle exec rspec

Credentials

Default credentials

email	Password	Role
[email protected]	password	Admin

Usage

Fire up the server:

rails s

Create a User

Grant admin rights to the user

Sign In

Create Measures (Admin Only)

Delete Measures (Admin Only)

Create Measurements

List all Measures with their measurements

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/NewAwesomeFeature)
3. Commit your Changes (git commit -m 'Add some NewAmazingFeature')
4. Push to the Branch (git push origin feature/NewAmazingFeature)
5. Open a Pull Request

Contact

Cyrus Kiprop - [email protected]

Project Link: https://github.com/Cyrus-Kiprop/afriTrend

Authors

👤 Cyrus Kiprop

• Github: Cyrus-Kiprop
• Twitter: @kipropJS
• Linkedin: Cyrus Kiprop

Acknowledgements

• Heroku
• Best-README-Template

License

Distributed under the MIT License. See LICENSE for more information.