https://github.com/alejandroq12/hello-rails
hello-rails
https://github.com/alejandroq12/hello-rails
Last synced: 2 months ago
JSON representation
hello-rails
- Host: GitHub
- URL: https://github.com/alejandroq12/hello-rails
- Owner: Alejandroq12
- License: mit
- Created: 2024-01-08T22:23:23.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-01-09T21:41:16.000Z (over 1 year ago)
- Last Synced: 2025-01-08T10:45:49.132Z (4 months ago)
- Language: Ruby
- Size: 70.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Ruby on Rails Hello World
Ruby on Rails Hello World
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Ruby on Rails Hello World ](#-ruby-on-rails-hello-world-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Database](#database)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)
This project was created to practice setting up a Ruby on Rails project with PostgreSQL as the database, the creation and implementation of views, controllers, migrations, adding documentation, and using GitFlow. In addition, it also plan to provide foundational knowledge about the folder and file structure of Ruby on Rails. All of these elements are essential pieces of knowledge for becoming a great Ruby on Rails developer. Later on, I will be working on more complex and robust projects, but as they say, first things first.
- **Hello world view.**
- **PostgreSQL as database.**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
[Install Ruby](https://www.ruby-lang.org/en/documentation/installation/)
### Setup
```sh
cd my-folder
git clone https://github.com/Alejandroq12/hello-rails.git
```
### Install
This project does not require additional dependencies, just Ruby interpreter. However, it uses RuboCop as a linter and you should set it up as well.
```sh
bundle install
```
### Database
Before running the migrations and seeds, ensure that PostgreSQL is installed and running:
```sh
sudo service postgresql start
```
Run migrations:
```sh
rake db:migrate
```
Add the seeds(omit it for this project):
```sh
rake db:seed
```
### Usage
To run the project, navigate to the project directory and execute the following command:
```sh
rails server
```
### Run tests
To run tests, run the following command:
This feature is under construction!
```sh
# rubocop
```
### Deployment
You can deploy this project using:
Not available at the moment.
👤 **Julio Quezada**
- GitHub: [Alejandroq12](https://github.com/Alejandroq12)
- Twitter: [@JulioAle54](https://twitter.com/JulioAle54)
- LinkedIn: [Julio Quezada](https://www.linkedin.com/in/quezadajulio/)
- **Add more views.**
- **Add validations.**
Contributions, issues, and feature requests are welcome!
If you like this project please give a star.
Thanks in advance.
I would like to thank all of my colleagues who inspire to do my best everyday.
**What did you learn?**
- I have learned about generating controllers, setting PostgreSQL as the default database, running migrations, understanding the project's file structure, configuring views, working with the project locally, using GitFlow, documenting a project, and adding instructions.
This project is [MIT](./LICENSE) licensed.