Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cancelei/hello2-react-front-end
This repo is part of the Microverse Programming Remote School.
https://github.com/cancelei/hello2-react-front-end
Last synced: about 1 month ago
JSON representation
This repo is part of the Microverse Programming Remote School.
- Host: GitHub
- URL: https://github.com/cancelei/hello2-react-front-end
- Owner: cancelei
- License: other
- Created: 2023-12-03T14:12:44.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2023-12-04T19:48:18.000Z (12 months ago)
- Last Synced: 2024-05-17T15:54:24.005Z (6 months ago)
- Language: JavaScript
- Size: 202 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Hello Rails Front-end
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Hello Rails Front-end ](#Hello Rails Front-end)
- [🛠 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)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
**Hello Rails Front-end** is an exercise with 2 repos, but features a random generated greeting message.
Here is the link to the BACKEND in Rails
Server
Database
Front-End
- **Setup a Dual Repo APP, using RubyRails Front-end and a React Front-end.**
- **Rails 7.1.1 (lastest)+ Postgres**
- **Latest React using (create-react-app command)**
To get a local copy up and running, follow these steps.
Note: We are assuming you have pre-installed ruby, WSL, ubuntu and rails!
### Prerequisites
In order to run this project you need:
first at all, install rails:
```sh
gem install rails -v 7.1.1
```
### Setup
Clone both repositories to your desired folder:
```sh
cd your-folder
[email protected]:cancelei/hello-rails-frontend.git
```
### Install
Install this project with:
```sh
cd hello-rails-frontend
bundle install
```
Setting up the Data Base:
```sh
"Set up Username and password information in the config/database.yml"
rails db:create
rails db:migrate
rails db:seed
```
### Usage
To run the project, execute the following command:
```sh
PORT=3001 npm start quote:"(on port 3001, remember to use port 3000 for back-end)"
```
### Deployment
The deployment will be available one day !
👤 **Glauber Bannwart**
- GitHub: [@cancelei](https://github.com/cancelei)
- LinkedIn: [Glauber Bannwart](https://www.linkedin.com/in/gbannwart/)
> We this project can improve, we are planning to include the next features soon:
- [x] **User Interface, Controllers and Models**
- [N/A] **API documentation**
- [x] **View Implementation**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/cancelei/hello2-react-front-end/issues).
> Would you like to help?
If you like this project feel free to leave an start, as well if you have a suggestion feel free to visit issues page.
I would like to thank Microverse for creating this exercise-project.
> Learn more about FAQ below:
- **How do I fix Linters errors if I modify the project?**
- for Eslint run
```sh
npx eslint "**/*.{js,jsx}"
```
- for Stylint run:
```sh
npx stylelint "**/*.{css,scss}" --fix
```
This project is [MIT](./LICENSE.md) licensed.