https://github.com/emmvs/five_things
What made you happy today?
https://github.com/emmvs/five_things
heroku javascript postgresql rails7 ruby-on-rails stimulusjs
Last synced: 9 months ago
JSON representation
What made you happy today?
- Host: GitHub
- URL: https://github.com/emmvs/five_things
- Owner: emmvs
- Created: 2022-11-30T14:51:52.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-05T11:16:30.000Z (almost 2 years ago)
- Last Synced: 2024-10-29T14:15:16.618Z (over 1 year ago)
- Topics: heroku, javascript, postgresql, rails7, ruby-on-rails, stimulusjs
- Language: Ruby
- Homepage:
- Size: 840 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Five Things App
## Overview
The 5 Things App is designed to help users appreciate the smaller joys in life by listing down five things that make them happy every day.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine
### Prerequisites & System Dependencies
Ensure that you have the following installed on your local machine:
* [Ruby](https://www.ruby-lang.org/en/documentation/installation/) - 3.1.2
* [Rails](https://guides.rubyonrails.org/v5.0/getting_started.html) - 7.0.6
* PostgreSQL
### Installation
1. Clone the repository to your local machine
`git clone https://github.com/yourusername/five-things.git`
2. Navigate to the project directory
`cd five-things`
3. Install necessary gems
`bundle install`
4. Install PostgreSQL
```
brew install postgresql
brew services start postgresql
```
### Database Creation
1. Create the database
`rails db:create`
3. Migrate the database
`rails db:migrate`
### Database Initialization
1. Seed the database
`rails db:seed`
### Running Tests
1. To run the complete test suite, execute
`rspec`
### Services
- Poetry Service: Fetches a random poem to display on the page.
### Deployment Instructions
1. Precompile assets
`rails assets:precompile`
3. Push to your deployment platform
## Contributing
If you would like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.
## Contact
- Repository: [Five Things App](https://github.com/emmvs/five_things)
- Developer: Emma Rünzel - emma@ruenzel.de
**Enjoy Five Things, and remember to appreciate the litte things!**
Made with ♥️ by emmvs