Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ruthmy/hello-rails-back-end
https://github.com/ruthmy/hello-rails-back-end
Last synced: 26 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ruthmy/hello-rails-back-end
- Owner: Ruthmy
- License: mit
- Created: 2023-10-26T13:35:15.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-11-14T14:48:13.000Z (about 1 year ago)
- Last Synced: 2023-11-14T15:48:08.245Z (about 1 year ago)
- Language: Ruby
- Size: 64.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Hello Rails - Backend
# 📗 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)
- [📝 License](#license)
---
**"Hello Rails - Backend"** is a small project to practice the basics of Ruby on Rails as an API to be consumed by a React/Redux Toolkit application.
Two repositories were created for its construction:
- [A backend repository](https://github.com/Ruthmy/hello-rails-back-end) with an API built with the [Ruby on Rails](https://rubyonrails.org/) Framework with a [PostgreSQL](https://www.postgresql.org/) database.
- [A frontend repository](https://github.com/Ruthmy/hello-react-front-end) with a React/Redux Toolkit application from which the created API is consumed.
---
### Tech Stack
The project is built using the following technologies:
* Ruby on Rails.
* PostgreSQL.
* Rubocop.
---
- Ruby on Rails
- Linters
- Rubocop
- Follow Microverse's list of best practices
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need to have:
- Installed Ruby and Ruby on Rails.
- If you're using Windows, have installed WSL.
- If you're using MacOS, an option is using UTM.
### Setup
To clone this repository to your desired folder, run the following command:
```
git clone https://github.com/Ruthmy/hello-rails-back-end
```
Navigate to the cloned repository and run the following command to install the necessary gems:
```
cd hello-rails-back-end
bundle install
```
Before continue you will need to create your own credentials file. To do so, first remove config/master.key and config/credentials.yml.enc if they exist.
run the following command:
```
EDITOR=code rails credentials:edit
```
You can close the editor that opens. This command will create a new master.key and credentials.yml.enc if they do not exist. Now you can continue.
## Usage
Initialize it with
```
rails server
```
Then open `http://localhost:4000` in your browser.
Now you need to create the database, run the following command:
```
rails db:create
```
Then migrate the database:
```
rails db:migrate
```
And finally, seed the database:
```
rails db:seed
```
### Test
To run the tests try the following command:
```
rspec spec
```
---
👤 **Ruth Abreu**
- GitHub: [@Ruthmy](https://github.com/Ruthmy)
- Twitter: [@rury_exe](https://twitter.com/rury_exe)
- LinkedIn: [LinkedIn](https://linkedin.com/in/ruth-abreu)
---
Upcoming improvements:
- [ ] Accessibility improvements.
---
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Ruthmy/hello-rails-back-end/issues).
---
If you like this project and know someone who might find it helpful, please share it.
Or give it a **star** ⭐️
---
I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.
---
This project is [MIT](./LICENSE) licensed.
---