Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Last synced: 12 days ago
JSON representation

Host: GitHub
URL: https://github.com/ndikumanaisaie/hello-rails-back-end
Owner: ndikumanaisaie
License: mit
Created: 2023-03-29T12:42:28.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-04-07T09:16:47.000Z (over 1 year ago)
Last Synced: 2024-05-28T16:21:39.222Z (6 months ago)
Language: Ruby
Size: 41 KB
Stars: 2
Watchers: 1
Forks: 0
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)

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

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 hello-rails-back-end 

>Backend api for connecting with the front end. 

## 🛠 Built With 

### Tech Stack 

  Server

  


    RoR

  

  Database

  

    Postgresql

  


### Key Features 

**You can do the following with app:**

- Run a hello World rails-react app

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

  * An IDE e.g [Visual studio code](https://code.visualstudio.com/).

  * [A terminal](https://code.visualstudio.com/docs/terminal/basics).

  * Make sure you have Ruby installed in your system. You can install it [here](https://www.ruby-lang.org/en/documentation/installation/)

  * Get started with [Ruby on Rails](https://guides.rubyonrails.org/getting_started.html).

  * Make sure you have [PostgreSQL](https://www.postgresql.org/) installed and running.

### Setup

Clone this repository to your desired folder or download the Zip folder:

```

git clone https://github.com/ndikumanaisaie/hello-rails-back-end.git

```

  * Navigate to the location of the folder in your machine:

  **`you@your-Pc-name:~$ cd hello-rails-back-end`**

### Install

To install all gems, run:

```

bundle install

```

### Usage

To run the project, follow these instructions:

  * After Cloning this repo to your local machine.

  * To get it running in your terminal, run it in your IDE

### Running the server

  *  Run rails `db:create:all` and `rails db:migrate`

  *  Run `rails db:seed` to populate the database with some sample data.

  *  Run `rails s` to start the server.

  *  In your browser, go to `http://localhost:3000`.

### Running the client side

  *  Run `npm start`

### Below is the link to the pull request for the front-end part of the project

  * [Front End](https://github.com/ndikumanaisaie/hello-react-front-end/pull/1)

(back to top)


## 👤 Authors 

👤 **Ndikumana Isaie**

- GitHub: [ndikumanaisaie](https://github.com/ndikumanaisaie)

- Twitter: [Ndikuma38670724](https://twitter.com/Ndikuma38670724)

- LinkedIn: [Ndikumana Isaie](https://www.linkedin.com/in/ndikumanaisaie/)

(back to top)


## 🔭 Future Features 

- [ ] **Implement more methods.**

- [ ] **Write Extra Message.**

(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 

Give a ⭐️ if you like this project and how I managed to build it!

(back to top)


## 🙏 Acknowledgments 

- I would like to thank Gregoire Vella on Behance, the author of the original design from which I took inspiration for this beautiful design in accordance with the Creative Commons license of the design.

- The original design ideal from Microverse💕.

- Project from [Microverse](https://bit.ly/MicroverseTN) Ruby / Database and Interviewing 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.

- Hat tip to anyone whose code was used.

(back to top)


## ❓ FAQ 

- **Can I fork and reuse the repository**

  - Yes please, 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](./LICENSE) licensed.

(back to top)