generated from Lucas-Erkana/RubyOnRails_template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #16 from Lucash2022/user-photo
Allow user to add a photo
- Loading branch information
Showing
15 changed files
with
216 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,150 @@ | ||
# README | ||
# 📗 Table of Contents | ||
|
||
This README would normally document whatever steps are necessary to get the | ||
application up and running. | ||
- [📗 Table of Contents](#-table-of-contents) | ||
- [📖 TDD Project ](#-oop-school-library--) | ||
- [🛠 Built With ](#-built-with-) | ||
- [Tech Stack ](#tech-stack-) | ||
- [Key Features](#key-features) | ||
- [🚀 Live Demo](#live-demo) | ||
- [📽️ Video Presentation](#video) | ||
- [💻 Getting Started ](#-getting-started-) | ||
- [Prerequisites](#prerequisites) | ||
- [Setup](#setup) | ||
- [Install](#install) | ||
- [Usage](#usage) | ||
- [Authors ](#authors-) | ||
- [🔭 Future Features ](#-future-features-) | ||
- [🤝 Contributing ](#-contributing-) | ||
- [⭐️ Show your support ](#️-show-your-support-) | ||
- [🙏 Acknowledgments ](#-acknowledgments-) | ||
- [📝 License ](#-license-) | ||
|
||
Things you may want to cover: | ||
## 📖 SpendSmart<a name="about-project"></a> | ||
SpendSmart is a web-based budgeting application built using Ruby on Rails and PostgreSQL. With SpendSmart, users can effortlessly track their income and expenses, gaining full control over their finances. 💰💼 | ||
|
||
* Ruby version | ||
## 🛠 Built With <a name="built-with"></a> | ||
|
||
* System dependencies | ||
## Tech Stack <a name="tech-stack"></a> | ||
|
||
* Configuration | ||
- [Ruby](https://www.ruby-lang.org/en/) | ||
- [Ruby on Rails](https://rubyonrails.org/) | ||
- [PostgreSQL](https://www.postgresql.org/) | ||
|
||
* Database creation | ||
## Key Features | ||
|
||
* Database initialization | ||
- [ ] **Register an account** | ||
- [ ] **Login registered account** | ||
- [ ] **Create categories and transactions** | ||
- [ ] **Upload Profile photo** | ||
|
||
* How to run the test suite | ||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
* Services (job queues, cache servers, search engines, etc.) | ||
### 🚀 Live Demo <a name="live-demo"></a> | ||
|
||
* Deployment instructions | ||
- [SpendSmart](#) | ||
|
||
* ... | ||
### 📽️ Video Presentation <a name="video"></a> | ||
|
||
[Video Presentation ] (https://www.loom.com/share/5d571397947b49f0a677c66a047801e0?sid=14c5b6cf-58cf-45bb-bf08-e4a63cb61bbb)-Powered by Loom | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 💻 Getting Started <a name="getting-started"></a> | ||
|
||
To get a local copy up and running, follow these steps. | ||
|
||
## Prerequisites | ||
|
||
In order to run this project you need to install the following on your machine: | ||
- [Ruby](https://www.ruby-lang.org/en/) | ||
- [Ruby on Rails](https://rubyonrails.org/) | ||
- [PostgreSQL](https://www.postgresql.org/) | ||
|
||
## Setup | ||
|
||
Clone this repository to your desired folder: | ||
|
||
Example commands: | ||
|
||
- Clone this repository using GitBash or the command Terminal: | ||
|
||
```sh | ||
git clone https://github.com/Lucash2022/SpendSmart.git | ||
|
||
cd SpendSmart | ||
``` | ||
|
||
## Install | ||
|
||
- Inside the project directory, install the project's dependencies: | ||
|
||
```sh | ||
bundle install | ||
``` | ||
|
||
- Create the app's database | ||
|
||
```sh | ||
rails db:create | ||
``` | ||
|
||
- Setup the app's database | ||
|
||
```sh | ||
rails db:setup | ||
``` | ||
## Usage | ||
|
||
```sh | ||
rails server | ||
``` | ||
- Runs the app local server | ||
|
||
|
||
## Authors <a name="authors"></a> | ||
|
||
👤 **Lucas Erkana** | ||
|
||
- GitHub: [@Lucash2022](https://github.com/Lucash2022) | ||
- Twitter: [@Lucas_David_22](https://twitter.com/@Lucas_David_22) | ||
- LinkedIn: [Lucas Erkana](https://www.linkedin.com/in/lucas-erkana/) | ||
- Frontend Mentor - [@PLucash2022](https://www.frontendmentor.io/profile/Lucash2022) | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 🔭 Future Features <a name="future-features"></a> | ||
|
||
- [ ] **Delete and edit transactions** | ||
- [ ] **User profile settings** | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 🤝 Contributing <a name="contributing"></a> | ||
|
||
Contributions, issues, and feature requests are welcome! | ||
|
||
Feel free to check the [issues page](https://github.com/Lucash2022/SpendSmart/issues). | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## ⭐️ Show your support <a name="support"></a> | ||
|
||
If you like this project please leave a star. Thank you 🙏 | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 🙏 Acknowledgments <a name="acknowledgements"></a> | ||
|
||
- I would like to thank Microverse for the great project idea. ❤️ | ||
- Credit goes to [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) whose original design was used. | ||
|
||
Icons were used from [Flaticon](https://www.flaticon.com/) | ||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
||
## 📝 License <a name="license"></a> | ||
|
||
This project is [MIT](./LICENSE) licensed. | ||
|
||
|
||
<p align="right">(<a href="#readme-top">back to top</a>)</p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# app/controllers/registrations_controller.rb | ||
class RegistrationsController < Devise::RegistrationsController | ||
private | ||
|
||
def sign_up_params | ||
params.require(:user).permit(:name, :email, :password, :password_confirmation, :photo) | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
#!/usr/bin/env bash | ||
# exit on error | ||
set -o errexit | ||
|
||
bundle install | ||
bundle exec rake assets:precompile | ||
bundle exec rake assets:clean | ||
bundle exec rake db:migrate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
class AddPhotoToUsers < ActiveRecord::Migration[7.0] | ||
def change | ||
add_column :users, :photo, :string | ||
end | ||
end |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
databases: | ||
- name: spendsmart | ||
databaseName: spendsmart | ||
user: spendsmart_user | ||
|
||
services: | ||
- type: web | ||
name: spendsmart | ||
runtime: ruby | ||
buildCommand: "./bin/render-build.sh" | ||
startCommand: "bundle exec puma -C config/puma.rb" | ||
envVars: | ||
- key: DATABASE_URL | ||
fromDatabase: | ||
name: spendsmart | ||
property: connectionString | ||
- key: RAILS_MASTER_KEY | ||
sync: false |