steveWDamesJr / hello-rails-backend

This app uses a Rails back-end as an API to display a random greeting message. Built with Ruby on Rails | PostgreSQL

Hello-Rails-Backend

This app uses a Rails back-end as an API to display a random greeting message

Enjoy your Greeting!

Link to REACT FRONTEND

REACT FRONTEND

Built With

• Ruby: version 3.02
• Ruby on Rails
• Terminal
• IRB
• Rubocop (linters)
• PostgreSQL

Milestones

Rails API

• Milestone 1: Create a new Rails API app called 'hello-rails-back-end'
• Milestone 2: Initialize the project with Git
• Milestone 3: PostgreSQL database is set up
• Milestone 4: Create a table for storing messages and create 5 different greetings
• Milestone 5: Create an API endpoint that selects a random greeting from the table - Create controller with an action and Rails route

Getting Started

To get a local copy up and running follow these simple example steps.

Pre-requisites

Make sure you have Ruby and Rails installed on your computer. If not, you can follow this tutorial to install them.

If you don't have PostgreSQL installed, you can follow this tutorial to install it.

Usage

In your terminal, navigate to your current directory and run this code

git clone https://github.com/steveWDamesJr/hello-rails-backend.git

Then run:

cd hello-rails-backend

Open the project in your favorite code editor. code . for VS Code.

• Use the command bundle install or just simply bundle to install all project dependencies.
• Run rails db:create db:migrate to create the database and run migrations.
• You might need to supply a username and password for your PostgreSQL database if you run into an error with the previous step.
• Simply navigate to config/database.yml and add your username and password to the username and password fields.

Start terminal

rails s

• Then click on http://127.0.0.1:3000

Enjoy as your app opens in the web browser

Run Linters:

To run rubocop we use:

rubocop

To autocorrect offenses with rubocop we use:

rubocop --auto-correct-all or rubocop -A

Testing

Within the projects working directory run test using the following command: bin/rails test test and the name of the .rb directory you want to test, in the terminal.

Author

👤 STEVE W DAMES JR

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Hat tip to anyone whose code was used

📝 License

This project is MIT licensed.