https://github.com/andercm/budges-app
https://github.com/andercm/budges-app
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/andercm/budges-app
- Owner: anderCM
- License: mit
- Created: 2023-06-05T14:47:25.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-06-08T05:16:33.000Z (about 3 years ago)
- Last Synced: 2025-02-05T14:28:43.916Z (over 1 year ago)
- Language: Ruby
- Size: 1.32 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Budges app
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
Budges app is a Ruby on Rails full-stack web application.
Client
Server
Database
- **Data Model**
To get a local copy up and running follow these simple example steps.
### Prerequisites
> You need the following tools be installed in your computer:
> - [Rails](https://guides.rubyonrails.org/)
> - [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
> - [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)
> - IDE
> - Etc
### Setup
Clone this repository to your desired folder:
```sh
cd my-prefered-folder
git clone https://github.com/anderCM/Budges-app
```
### Install
Install this project with:
```sh
cd Recipe-app
bundle install
```
### 💾 Database
Create the databases and run migrations with:
```sh
rails db:create
rails db:migrate
rails db:seed
```
### Usage
To run the project, execute the following command:
```sh
rails tailwindcss:build
rails server or rails s
```
### Run tests
To run tests, run the following command:
```sh
rails db:migrate RAILS_ENV=test
rspec spec
```
If you are having problems with tests, please clean application caché and make sure you have executed.
```sh
rails db:seed
```
Presenting project:
You can watch the video clicking this [here](https://www.loom.com/share/34831f0e4e334f8a9539f28d63813c3a)
### Deployment
Feel free to use this username and password
```sh
email: admin@microverse.com
password: 12345678
```
or you can create your own account visiting [the page](https://throbbing-feather-4836.fly.dev/)
👤 **Anderson**
- GitHub: [@Anderson](https://github.com/anderCM)
- LinkedIn: [Anderson](https://www.linkedin.com/in/andersoncanales/)
- [ ] **CRUD for budges**
- [ ] **Awesome UI**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/anderCM/Budges-app/issues).
If you like this project please give it a star 😁🌟✨
## 🙏 Acknowledgments
- Thanks to Gregoire Vella(original idea). Find original design [here](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=)
Thanks to Microverse for providing us with the right material to aid this project development
This project is [MIT](./LICENSE) licensed.