sadaf-Daneshgar / Hello_Rails_React

Hello Rails React👋

📗 Table of Contents

• 👋 Hello Rails React
• 🛠 Built With
• Key Features
• Future Features
• 💻 Getting Started
• Setup
• Prerequisites
• Usage
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show Your Support
• 🙏 Acknowledgments
• 📜 License

👋 Hello Rails React

🛠 Built With

Client

• HTML

• CSS3

• JavaScript

• React

• Redux

• Ruby on Rails

Key Features

• Creating a data model
• Creating a Rails API
• Creating a React app
• Connecting the React app to the Rails API
• Creating a React component
• Using React hooks

• HTML & CSS3
• JavaScript
• Linters
  • StyleLint
  • ESLint
  • Rubocop
• React
• Redux
• Ruby
• Ruby on Rails
• Follow Microverse's list of best practices

🔭 Future Features

• Adding styling to the React app
• Adding more features to the React app
• Adding more features to the Rails API

💻 Getting Started

To get started with the Budget App, follow the instructions below:

🛠 Setup

1. Clone the project repository:

   git clone https://github.com/sadaf-Daneshgar/Hello_Rails_React.git

2. Navigate to the project folder:

   cd hello-rails-react

Prerequisites

Before you can run the Budget App, make sure you have the following prerequisites and configurations in place:

• Ruby: Ensure that Ruby is installed on your machine. You can check if it's installed by running ruby -v in your terminal. If it's not installed, you can download and install it from the official Ruby website.

• Ruby on Rails: You'll need the Ruby on Rails framework installed. If you don't have it yet, you can install it using the following command:

  gem install rails
  

• Code Editor: You should have a code editor like Visual Studio Code (VSCode) installed. You can download VSCode from the official website.

• Git: Git is essential for version control. Make sure you have Git installed and configured on your system. You can download Git from the official Git website.

• PostgreSQL: Ensure that PostgreSQL is installed and properly configured on the server where you are developing the project. This project assumes the use of PostgreSQL as the default database. You can download PostgreSQL from the official PostgreSQL website.

• Ruby on Rails Configuration: Make sure your Ruby on Rails project is configured to use PostgreSQL as the default database.

With these prerequisites and configurations in place, you'll be ready to set up and run the Blog App.

📖 Usage

Follow these steps to use the Blog App:

Open your terminal.

Navigate to the directory where the project files are located:

Copy code

 For frontend only:
 cd frontend-react-app
 npm start  // git bash terminal
 For backend only:
 rails s    // wsl terminal
 ```ls server

Open your web browser and go to http://localhost:3000 to access the Hello Rails React app.

👥 Authors

👤 Sadaf Daneshgar

• 👤 GitHub: @Sadaf-Daneshgar
• 👤 Twitter: @SadafDaneshgar
• 👤 LinkedIn: Sadaf Daneshgar

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page and contribute to the project.

⭐️ Show Your Support

If you like this project, kindly drop a start ⭐️ for the repository;

(back to top)

🙏 Acknowledgments

I would like to thank the following individuals and organizations for their contribution to this project.

• I would like to express my heartfelt gratitude to Microverse for the invaluable learning experience they have provided.

(back to top)

📜 License

This project is MIT licensed.