Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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.
https://github.com/cyrus-kiprop/rails-react-health-app
jwt-authentication models mvc postgresql rails-api rails6 react redux requests rspec shoulda-matchers token
Last synced: 11 days ago
JSON representation
Health app curated using Rails apis and React-redux front-end. With the api endpoints, users can keep track of their fitness leves.
- Host: GitHub
- URL: https://github.com/cyrus-kiprop/rails-react-health-app
- Owner: Cyrus-Kiprop
- License: mit
- Created: 2020-09-02T17:49:34.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2020-09-08T13:43:28.000Z (over 4 years ago)
- Last Synced: 2025-01-20T04:53:06.258Z (11 days ago)
- Topics: jwt-authentication, models, mvc, postgresql, rails-api, rails6, react, redux, requests, rspec, shoulda-matchers, token
- Language: Ruby
- Homepage:
- Size: 6.73 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
Health App API
A simple health api app.
Report Bug
·
Request Feature
## Table of Contents
- [About the Project](#about-the-project)
- [Api Documentation](#api-documentation)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#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 ](https://web.postman.co/collections/8007314-882ee6da-afb0-49db-9eaa-4e9c94059972?version=latest&workspace=ab4298f5-d0f8-4bf1-8dc4-baa6db7fbe13) for api documentation.
### Built With
The project was built using the following languages stacks:
```sh
Back-End(server)
```
- [Ruby -v 2.7.1](https://ruby-doc.org/)
- [Ruby on Rails -v 5.2+](https://rubyonrails.org/)
```sh
Testing Frameworks
```
- shoulda_matchers
- [RSpec](https://rspec.info/)
- 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](https://www.ruby-lang.org/en/)
- Rails -v 5.2.4+
```sh
gem install rails -v 5.2.4
```
- Postgresql database [click here](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-18-04)
### Installation
1. Clone the repo
```sh
git clone https://github.com/Cyrus-Kiprop/rails-react-health-app.git
```
2. CD into the project root directory
```sh
cd ./rails-react-health-app
```
3. Install Dependencies and gems
```sh
bundle install
```
4. Set the databases
```sh
rails db:create
```
5. Create database schemas
```sh
rails db:migrate
```
6. Seed the DB
```sh
rails db:seed
```
7. Run rspec tests
```sh
bundle exec rspec
```
## Credentials
### Default credentials
| email | Password | Role |
| ------------------| ------------- | ----- |
| [email protected] | password | Admin |
## Usage
### Fire up the server:
```JS
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](https://github.com/Cyrus-Kiprop/rails-react-health-app/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](https://github.com/Cyrus-Kiprop/rails-react-health-app)
## Authors
👤 **Cyrus Kiprop**
- Github: [Cyrus-Kiprop](https://github.com/Cyrus-Kiprop)
- Twitter: [@kipropJS](https://twitter.com/kipropJS)
- Linkedin: [Cyrus Kiprop](https://www.linkedin.com/in/cyrus-kiprop-ba7320120/)
## Acknowledgements
- [Heroku](https://afritrend.herokuapp.com)
- [Best-README-Template](https://github.com/othneildrew/Best-README-Template)
## License
Distributed under the MIT License. See [ LICENSE ](https://github.com/Cyrus-Kiprop/rails-react-health-app/raw/master/LICENSE) for more information.
[contributors-shield]: https://img.shields.io/github/contributors/Cyrus-Kiprop/rails-react-health-app.svg?style=flat-square
[contributors-url]: https://github.com/Cyrus-Kiprop/rails-react-health-app/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Cyrus-Kiprop/rails-react-health-app.svg?style=flat-square
[forks-url]: https://github.com/Cyrus-Kiprop/rails-react-health-app/network/members
[stars-shield]: https://img.shields.io/github/stars/Cyrus-Kiprop/rails-react-health-app.svg?style=flat-square
[stars-url]: https://github.com/Cyrus-Kiprop/rails-react-health-app/stargazers
[issues-shield]: https://img.shields.io/github/issues/Cyrus-Kiprop/rails-react-health-app.svg?style=flat-square
[issues-url]: https://github.com/Cyrus-Kiprop/rails-react-health-app/issues