Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/najibullahjafari/hello-rails-back-end
The Hello-rails-back-end is a rails project, here I created an API using Ruby on Rails and I created the front-end of this app with react to connect with this api.
https://github.com/najibullahjafari/hello-rails-back-end
api create-api rails ror ruby
Last synced: 8 days ago
JSON representation
The Hello-rails-back-end is a rails project, here I created an API using Ruby on Rails and I created the front-end of this app with react to connect with this api.
- Host: GitHub
- URL: https://github.com/najibullahjafari/hello-rails-back-end
- Owner: najibullahjafari
- License: mit
- Created: 2023-11-10T04:02:28.000Z (12 months ago)
- Default Branch: dev
- Last Pushed: 2023-11-10T11:33:26.000Z (12 months ago)
- Last Synced: 2024-10-10T08:42:57.702Z (29 days ago)
- Topics: api, create-api, rails, ror, ruby
- Language: Ruby
- Homepage:
- Size: 62.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Hello Rails Back-end
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Hello Rails Back-end ](#ruby-on-rails-group-project)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
**Hello rials Back-end**
Hello rails Back-end is an application that rails as an API.
> So you want to lear more about the tech we have used for this project?
Server
Database
Front-end
- **Make use for migrations features from Active Record**
- **Include Tables for User, Categories and Transactions**
- **Include React**
To get a local copy up and running, follow these steps.
Note: We are assuming you have pre-installed ruby, WSL, ubuntu and rails!
### Prerequisites
In order to run this project you need:
first at all, install rails:
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/najibullahjafari/hello-rails-back-end
```
### Install
Install this project with:
```sh
bundle install
```
Setting up the Data Base:
```sh
rails db:create
rails db:migrate
rails db:seed
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Run tests
Before running tests, ensure you've set up the test database:
```sh
bin/rails db:migrate RAILS_ENV=test
```
**Note:** Given that the aim of this project is to test the application's UI, to see if it works without side effects. We have therefore had to modify the contents of certain files, which could have the effect of falsifying certain `Unit` tests.
We therefore recommend that, rather than running all the tests, you only test the `features` folder.
```sh
bundle exec rspec ./spec/features
```
### Install
Install this project with:
```sh
cd hello-rails-back-end
bundle install
```
Setting up the Data Base:
```sh
rails db:create
rails db:migrate
rails db:seed
```
👤 **Najibullah Jafari**
- GitHub: [Najibullah_jafari](https://github.com/najibullahjafari)
- Twitter: [Najibullah_jafari](https://twitter.com/Najib_Jafari_)
- LinkedIn: [Najibullah_jafari](https://www.linkedin.com/in/najibullahjafari/)
> We this project can improve, we are planning to include the next features soon:
- [x] **User Interface**
- [x] **Validations**
- [x] **API documentation**
- [x] **Model Data**
- [x] **Controllers Testing**
- [x] **Models Testing**
- [x] **View Implementation**
- [x] **User Interface**
- [x] **Validations**
- [x] **API documentation**
- [x] **Model Data**
- [x] **Controllers Testing**
- [x] **Models Testing**
- [x] **View Implementation**
- [x] **Integration Testing**
- [x] **Unit Testing**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/najibullahjafari/hello-rails-back-end/issues).
> Would you like to help?
If you like this project feel free to leave an star, as well if you have a suggestion feel free to visit issues page.
I would like to thank Microverse.
> Learn more about FAQ below:
- **How do I fix Linters errors if I modify the project?**
- for rubocop run
```sh
rubocop -A
```
- for Stylint run:
```sh
npx stylelint "**/*.{css,scss}" --fix
```
This project is [MIT](./LICENSE) licensed.