https://github.com/thebwoyprogrammer/hello_rails_react
https://github.com/thebwoyprogrammer/hello_rails_react
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/thebwoyprogrammer/hello_rails_react
- Owner: theBwoyProgrammer
- License: mit
- Created: 2022-11-29T15:30:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-30T00:29:41.000Z (over 3 years ago)
- Last Synced: 2025-02-04T11:05:36.563Z (over 1 year ago)
- Language: Ruby
- Size: 199 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Microverse README Template
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
> Describe your project in 1 or 2 sentences.
**[Hello rails react]** is a simple web app to test working with rails and react
> Describe the tech stack and include only the relevant sections that apply to your project.
Client
Server
Database
> Describe between 1-3 key features of the application.
- **[This app has API end points]**
- **[It fetches from the API and renders the data]**
- **[It renders random greetings on refreshing and navigating to the './message']**
> Add a link to your deployed project.
- Coming Soon
> Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- [Ruby](https://www.ruby-lang.org/en/)
- [Postgresql](https://www.postgresql.org/)
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/)
- [Rails](https://rubyonrails.org/)
### Setup
Clone this repository to your desired folder by running these commands:
- $ git clone https://github.com/techwolf404/hello_rails_react.git
- $ cd hello_rails_react
### Install
Install this project with:
Run
```bash
$ bundle install
```
To get all the gems required for the project
Then, run
```bash
$ npm install
```
To install packages such as style linters
To check linters locally, use
```bash
$ rubocop
$ npx stylelint "**/*.{css,scss}"
```
Once you have the project correctly set up, run
```bash
$ bin/rails db:setup
```
### Usage
To run the project, execute the following command:
- ./bin/dev or rails s
> Mention all of the collaborators of this project.
👤 **Hatim Eddinani**
- GitHub: [@techwolf404](https://github.com/techwolf404)
- Twitter: [@the_BwoyProgrmmr](https://twitter.com/the_BwoyProgrmmr)
- LinkedIn: [@Hatim Eddinani](https://www.linkedin.com/in/hatimdev/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/techwolf404/hello_rails_react/issues/).
> Write a message to encourage readers to support your project
If you like this project give a ⭐️ and follow my profile links so that we can connect
> Give credit to everyone who inspired your codebase.
I would like to thank Microverse for this opportunity
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._