/hello-rails-react

Primary LanguageRubyMIT LicenseMIT

Hello-Rails-React

📗 Table of Contents

📖 Hello-Rails-React

🛠 Built With

Tech Stack

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

    • Display random Greeting

    (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:

    Code Editor (Vs Code)
    
    Terminal
    
    Install ruby on your computer
    
    Install rails on your compute

    Setup

    Clone this repository to your desired folder:

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

    You need to setup database for these project

      development = your_dataabase_dev
      test        = your_datasebase_test
      production  = your_datasebase_prod
    

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

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

    Install

    Install this project with:

      bundle install
    
      npm install
      or
      yarn install

    it will install the required gemfile for running the project

    Usage

    To run the project, execute the following command on Your Git Bash Terminal:

     bin/dev

    Run tests

    To run tests on linters, run the following command:

      npx stylelint "**/*.{css,scss}"
      rubocop

    (back to top)

    👤 Author

    👤 Yonas Henok

    (back to top)

    🔭 Future Features

    • Add More Functionality

    (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 please give it a Start ⭐️.

    (back to top)

    🙏 Acknowledgments

    • Project from Microverse FULL-STACK CAPSTONE Module.
    • Thanks to the Microverse team for the great curriculum.
    • Thanks to the Code Reviewer(s) for the insightful feedbacks.
    • A great thanks to My coding partner(s), morning session team, and standup team for their contributions.

    (back to top)

    ❓ FAQ

    • Can I Fork it and Imporove on it

      • Yes, You can, feel free.
    • Can I improve the repository, and my changes will be accepted if they are good?

      • Yes please, nice ideas are welcome, please.

    (back to top)

    📝 License

    This project is MIT licensed.

    (back to top)