/hello-rails-react

Primary LanguageRubyMIT LicenseMIT

Rails-React

📗 Table of Contents

📖 Rails-React

Rails-React is a app that have 5 greetings

🛠 Built With

Tech Stack

Client
  • React
  • Server
  • Ruby
  • Rails
  • Database
  • Postgres
  • Key Features

    • Built using Ruby on Rails with React

    (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 >= 3.2.0
        rails >= 7.0
        postgres >- 15.3
        node
    

    Setup

    Clone this repository to your desired folder:

      git clone https://github.com/Othniel2471/hello-rails-react.git

    You need to setup database for these project

      development = hello_rails_react_dev
      test        = hello_rails_react_test
      production  = hello_rails_react_prod
    

    or you can use your own database and change the config/database.yml

    default: &default
      adapter: postgresql
      encoding: unicode
      pool: 5
      username: [your_username]
      password: [your_password]
      host: localhost
    
    development:
      <<: *default
      database: [your_database_for_development]
    
    test:
      <<: *default
      database: [your_database_for_test]
    
    production:
      <<: *default
      database: [your_database_for_production]

    Install

    Install this project with:

      cd hello_rails_react
      bundle install
      npm install

    it will install the required gemfile for running the project

    Usage

    to use this project:

       npm run build
       bin/rails server

    it will run the the server on localhost:3000

    (back to top)

    👥 Author

    👤 OMAIDU OTHNIEL

    (back to top)

    🔭 Future Features

    • Add UI System

    (back to top)

    🤝 Contributing

    Contributions, issues, and feature requests are welcome!

    Feel free to check the issues page.

    (back to top)

    ⭐️ Show your support

    If you like this project you can share this project to your friend

    (back to top)

    🙏 Acknowledgments

    I would like to thank microverse for this project

    (back to top)

    📝 License

    This project is MIT licensed.

    (back to top)