Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/meryemsanem/hello-rails-react


https://github.com/meryemsanem/hello-rails-react

Last synced: 2 days ago
JSON representation

Awesome Lists containing this project

README

        


Hello Rails React


## 📗 Table of Contents

- [📖 Hello Rails React](#-about-project)
- [🛠 Built With](#-built-with)
- [🌟 Key Features](#-key-features)
- [💻 Getting Started](#-getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [👥 Authors](#-authors)
- [🔭 Future Features](#-future-features)
- [🤝 Contributing](#-contributing)
- [⭐️ Show Your Support](#️-show-your-support)
- [🙏 Acknowledgments](#-acknowledgments)
- [📝 License](#-license)

## 📖 Hello Rails React

**Hello Rails React** is a full-stack web application powered by Ruby on Rails for the backend and React for the frontend. It displays a random greeting from the collection of greetings.

## 🛠 Built With

### Tech Stack

- [Ruby on Rails](https://rubyonrails.org) - A powerful web application framework.
- [PostgreSQL](https://www.postgresql.org) - An open-source relational database.
- [Bundler](https://bundler.io) - A tool for managing Ruby gem dependencies.

### Key Features

- **Random Greetings:** The app displays random greetings from a collection of messages.

(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 to have the following installed:

- **Rails:** Ensure you have Ruby on Rails installed. You can find installation instructions at [Ruby on Rails](https://rubyonrails.org/).

- **PostgreSQL:** This project uses PostgreSQL as the relational database. If you don't have it, you can download it from [PostgreSQL](https://www.postgresql.org/download/).

- **Bundler:** Bundler is a tool for managing Ruby gem dependencies. Install it by running gem install bundler if you don't already have it.

- **React:** React is a JavaScript library used for building the frontend of the application. You can learn more about React at [React](https://reactjs.org/).

- **Webpack:** Webpack is a module bundler for JavaScript and other files. It's used to bundle and optimize the frontend assets. You can find more information about Webpack at [Webpack](https://webpack.js.org/).

- **Yarn:** Yarn is a package manager for JavaScript. You can install Yarn by following the instructions at [Yarn](https://classic.yarnpkg.com/en/docs/install/).

- **Redux:** Redux is a state management library used for managing application state in the frontend. You can learn more about Redux at [Redux](https://redux.js.org/).

### Setup

Clone this repository to your desired folder:

```bash
git clone https://github.com/meryemsanem/hello-rails-react.git
```

### Install

Install this project with:

```bash
cd hello-rails-react
bundle install
```

it will install the required gemfile for running the project

(back to top)

## 👥 Author

👤 **Meryem Sanem Küçükbayram**

- GitHub: [Meryem Sanem Küçükbayram](https://github.com/meryemsanem)
- LinkedIn: [Meryem Sanem Küçükbayram](https://www.linkedin.com/in/meryemsanemkucukbayram/)

(back to top)

## 🔭 Future Features

- **Styling**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/meryemsanem/hello-rails-react/issues).

(back to top)

## ⭐️ Show your support

If you find this project helpful or interesting, star this repository on GitHub to let me know you like the project. ⭐️

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse.

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)