https://github.com/powerlevel9000/hello-rails-react
https://github.com/powerlevel9000/hello-rails-react
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/powerlevel9000/hello-rails-react
- Owner: PowerLevel9000
- License: gpl-3.0
- Created: 2023-07-12T00:36:53.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-07-17T16:10:19.000Z (almost 3 years ago)
- Last Synced: 2025-02-13T17:21:57.761Z (over 1 year ago)
- Language: Ruby
- Size: 649 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ๐ Table of Contents
- [๐ About the Project](#about-project)
- [๐งช Linters](#linters)
- [๐ 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)
- [๐ฅ Authors](#authors)
- [๐ญ Future Features](#future-features)
- [๐ค Contributing](#contributing)
- [โญ๏ธ Show your support](#support)
- [๐ Acknowledgements](#acknowledgements)
- [๐ License](#license)
Random Greet is `Ruby on Rails` based project
Random greet is a app which give random greeting each time it reload
## ๐งช Linters And test
[](https://github.com/PowerLevel9000/hello-rails-react/actions/workflows/linters.yml)
In this project we utilize our skills and knowledge to create this project
Project language
FrameWork
DataBase
- **Random Greet**
- **Render With React**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Ruby installed in your machine
- Ruby on Rails installed in your machine
- Postgres installed and all password and user being setup
- Any integrated terminal like
- CMD
- Bash
- PowerShell
- etc
### Setup
Clone this repository to your desired folder:
for cloning follow this steps
- go to green `code` button very top left corner of this Repository container
- copy your `SSH` or `https` file and clone it in your desired folder
- or just download `ZIP` file
- [ ] Change UserName and Password with yours in [database.yml](./config/database.yml) file
### Install
Install this project with:
for now you don't need any installation to run project if you already followed [Prerequisites](#prerequisites)
and
```
bundle install
```
```
npm install
```
### Usage
To run the project, execute the following command:
you can use it for you library purpose
run following commands in you `terminal` in root `dir` and if you open http://localhost:3000/ you can see App running
and API route ' http://localhost:3000/api/v1/greetings'
```
rails s
```
### Run tests
To run tests, run the following command:
```
rspec spec
```
And for Linters
```
rubocop . //=> for ruby file linting
npx stylelint "**/*.{css,scss}" //=> for CSS or SASS file linting
```
`-A` and `--fix` for auto fixing respectively
๐ค **Adarsh Pathak**
- GitHub: [@PowerLevel9000](https://github.com/PowerLevel9000)
- Twitter: [@PowerLevel9002](https://twitter.com/PowerLevel9002)
- LinkedIn: [Adarsh pathak](https://linkedin.com/in/PowerLevel)
- [ ] **Styling of various webpage**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project please give it star or buy me a coffee
I would like to thank microverse to give this opportunity to show up my skills
and the Ruby on rails docs
This project is [GPL-3.0](./LICENSE) licensed.