https://github.com/devmunyi/hello_rails_app
This project is meant for setting up a "Hello world" Rails project as one app with Webpack
https://github.com/devmunyi/hello_rails_app
Last synced: 21 days ago
JSON representation
This project is meant for setting up a "Hello world" Rails project as one app with Webpack
- Host: GitHub
- URL: https://github.com/devmunyi/hello_rails_app
- Owner: devMunyi
- License: mit
- Created: 2023-02-20T16:20:34.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-02-21T07:02:32.000Z (over 3 years ago)
- Last Synced: 2025-01-09T18:01:58.717Z (over 1 year ago)
- Language: Ruby
- Size: 744 KB
- Stars: 1
- 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)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
# 📖 Hello React Rails
**Hello React Rails** is a project is meant for setting up a "Hello world" Rails project as one app with Webpack and React. It is meant to be a starting point for a Rails project with React.
Client
Server
- Rails
Database
- **[Random Greeting message]**
- **[Single Fullstack web app]**
- [Live Demo Link] :smiley: not yet available
### Prerequisites
In order to run this project you need followed installed on your computer:
- Ruby v3+,
- Rails v7+
- PostgreSQL
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).
### Setup
Clone this repository to your desired folder or download the Zip folder:
```
git clone https://github.com/devMunyi/hello_rails_app
```
- Navigate to the location of the folder in your machine:
**`you@your-Pc-name:~$ cd hello_rails_app`**
### Installations
Install dependencies to this project with:
```
bundle install
```
```
npm install
```
Setup Database (Mandatory)
- Create `.env` file and add the following three lines(be sure to replace with your details):
```
POSTGRES_HOST='localhost'
POSTGRES_USERNAME='your_postgress_username'
POSTGRES_PASSWORD='your_postgress_password'
```
-To create database run:
```
rails db:create
```
If you have made a migration then run this command
```
rails db:migrate
```
```
rails db:seed
```
### Usage
To run the project, execute the following command:
```
./bin/dev # for building css, and webpack, and rails server
```
Or
```
rails server or rails s # after build
```
👤 **Samuel Munyi**
- GitHub: [@devMunyi](https://github.com/devMunyi)
- LinkedIn: [Samuel Munyi](https://www.linkedin.com/in/samuel-munyi)
- Twitter: [@munyi_sam](https://twitter.com/munyi_sam)
- [ ] **[Add Loading Icon awaiting api call to send response]**
- [ ] **[Add more features on UI including styling]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project!
I would like to thank:
- [Microverse](https://www.microverse.org/)
- Code Reviewers
This project is [MIT](./LICENSE) licensed.