Code Monkey home page Code Monkey logo

hello-rails-back-end's Introduction

๐Ÿ“— Table of Contents

Hello Rails Backend is a basic Rails API that has an endpoint that returns a random greeting from a previously set-up database table in JSON format. You can find the front end built with React here. This has been made as an exercise for Microverse Bootcamp.

๐Ÿ›  Built With

Tech Stack

Client
Server
Database

Key Features

  • Returns a random greeting from the API endpoint in JSON format.
  • Ruby on Rails API implementation.
  • PostgreSQL database used.

(back to top)

๐Ÿš€ Live Demo

This is simply an exercise and it will not be deployed.

(back to top)

๐Ÿ’ป Getting Started

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

Prerequisites

To run this project you need:

  • Ruby version 2.7.0+
  • Rails version 7+
  • PostgreSQL
  • Node.js
  • Npm or Yarn

Setup

Clone this repository to your desired folder:

https://github.com/crclothier/hello-rails-back-end.git
cd hello-rails-back-end

Install

Install this project with:

bundle install
npm install

or

yarn install

Usage

This app uses PostgreSQL databases for data preservation. Please provide valid credentials in the /config/database.yml file.

To initialize the database run:

rails db:create
rails db:migrate

To create initial data in your database run:

rails db:seed

This will create 5 records with greetings in different languages.

To run the server, execute the following command:

rails s` or `rails server

This will start the server on http://localhost:3000/
To reach the API endpoint go to http://localhost:3000/api/greeting

Run tests

N/A

Deployment

N/A

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Chris Clothier

(back to top)

๐Ÿ”ญ Future Features

User suggested greetings - create an API endpoint for user suggested greetings to be submitted and added to the greetings list.

(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 star โญ

(back to top)

๐Ÿ™ Acknowledgments

  • Microverse Bootcamp
  • Your name will go here if you contribute ๐Ÿ˜Ž

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

hello-rails-back-end's People

Contributors

crclothier avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.