https://github.com/strangeal/hello-rails-back-end

https://github.com/strangeal/hello-rails-back-end

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/strangeal/hello-rails-back-end
• Owner: Strangeal
• License: mit
• Created: 2023-02-20T18:54:33.000Z (about 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-02-21T01:49:52.000Z (about 2 years ago)
• Last Synced: 2024-12-09T16:53:00.914Z (2 months ago)
• Language: Ruby
• Size: 34.2 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

   - [Run Test](#run-tests)

  - [Run Linters](#run-tests)

  - [Run Endpoints](#Api-Endpoint-Testing)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 [Hello rails back-end] 

> Hello rails back-end is a project that I built as a practical start for learning how to create a separate backend and an api endpoint to be consumed by other front-end frameworks like ReactJs, VueJs etc. In this project i used postgreqsl as a database management system. In this project I set up a table that stores messages in an api endpoint.

**[Hello rails back-end]** is a ruby Api endpoint for storing messages.

## 🛠 Built With 

### Tech Stack 

> Hello rails back-end is a backend api only rails project

Back-end

  


    
Rails

  


Database

  


    
PostgreSQL

  


### Key Features 

> We can do CRUD operations on following things:

- **Api Endpoint**

(back to top)


## 🚀 Live Demo 

> Add a link to your deployed project.

- [Comming Soon 🎈]()

(back to top)


## 💻 Getting Started 

> In order to start with this project do as follows :

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

### Prerequisites

In order to run this project you need:

`gem install rails`

### Setup

Clone this repository to your desired folder:

`git clone [email protected]:Strangeal/hello-rails-back-end.git`

then

`cd hello-rails-back-end`

### Install

Install this project with:

`bundle install`

### Usage

`rails s`

### Run Test

To run app test. run the following commad:

`rspec`

### Run Linters

To run tests, run the following command:

`rubocop`

OR

`rubocop -a` 

**it will automatically correct the errors**

### Api-Endpoint-Testing

(back to top)


## 👥 Authors 

👨‍💻 **Justice Bajeri**

- GitHub: [Link to Github Profile](https://github.com/Strangeal)

- Twitter: [Link to Twitter Profile](https://twitter.com/Str_angeal)

- LinkedIn: [Link to LinkedIn Profile](https://www.linkedin.com/in/justice-bajeri-0b7211243/)

(back to top)


## 🔭 Future Features 

> In upcoming weeks I will add some features as mentioned below

- [ ] **Authentication and Authorization**

- [ ] **API & Documentation**

### Api-Endpoint-Testing

## 💻 Front-end Repository 

- [Click Here](https://github.com/Strangeal/hello-react-front-end)

- Clone this repository to your desired folder:

- Example command:

  ```

    git clone [email protected]:Strangeal/hello-react-front-end.git

    cd hello-react-front-end

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project then please give a ⭐️ and also share your feedback using github_issues.

(back to top)


## 🙏 Acknowledgments 

❤️ [RoR Documentation](https://guides.rubyonrails.org)

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)