https://github.com/powerlevel9000/react-rails-frontend
https://github.com/powerlevel9000/react-rails-frontend
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/powerlevel9000/react-rails-frontend
- Owner: PowerLevel9000
- License: gpl-3.0
- Created: 2023-07-16T01:00:02.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-24T13:54:44.000Z (almost 3 years ago)
- Last Synced: 2025-02-13T17:21:58.877Z (over 1 year ago)
- Language: JavaScript
- Size: 801 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Backend repo
[GitHub Repository](https://github.com/PowerLevel9000/react-rails-backend)
# 📗 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-frontend is just a simple Api fetching using react and redux for simple Greeting
## 🛠 Built With
In this project we utilize our skills and knowledge to create this project
Project language
- Javascript
FrameWork
- React
DataBase
- Postgres
- Api fetching With Random Greetings Endpoint (backend)
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
- node 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 and Backend 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
```
npm install // for frontend
```
```
bundle install // for backend
```
### 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
```
npm start
rails s -p 5000 // for backend
```
### 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)
- Archive Greetings
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.