An open API service indexing awesome lists of open source software.

https://github.com/powerlevel9000/react-rails-backend


https://github.com/powerlevel9000/react-rails-backend

Last synced: 12 months ago
JSON representation

Awesome Lists containing this project

README

          


logo

# Frontend repo
[GitHub Repository](https://github.com/PowerLevel9000/react-rails-frontend)

# 📗 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)
- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 React-Rails-Backend

React-Rails-Backend is just a simple Api End point for simple Greeting
## 🛠 Built With

### Tech Stack

In this project we utilize our skills and knowledge to create this project

Project language

FrameWork

DataBase

### Key Features

- Api With Random Greetings Endpoint

(back to top)

## 💻 Getting Started

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
```
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

(back to top)

## 👥 Authors

👤 **Adarsh Pathak**

- GitHub: [@PowerLevel9000](https://github.com/PowerLevel9000)
- Twitter: [@PowerLevel9002](https://twitter.com/PowerLevel9002)
- LinkedIn: [Adarsh pathak](https://linkedin.com/in/PowerLevel)

(back to top)

## 🔭 Future Features

- Archive Greetings

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project please give it star or buy me a coffee

(back to top)

## 🙏 Acknowledgments

I would like to thank microverse to give this opportunity to show up my skills

and the Ruby on rails docs

(back to top)

## 📝 License

This project is [GPL-3.0](./LICENSE) licensed.

(back to top)