https://github.com/altontonn/openflights
Open Flight is a review app built with react.js and ruby on rails with webpacker
https://github.com/altontonn/openflights
rails reactjs ruby styled-components
Last synced: 3 months ago
JSON representation
Open Flight is a review app built with react.js and ruby on rails with webpacker
- Host: GitHub
- URL: https://github.com/altontonn/openflights
- Owner: altontonn
- License: mit
- Created: 2023-06-13T17:04:16.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-11-26T12:49:56.000Z (over 2 years ago)
- Last Synced: 2025-02-07T22:46:12.985Z (over 1 year ago)
- Topics: rails, reactjs, ruby, styled-components
- Language: Ruby
- Homepage:
- Size: 1.76 MB
- Stars: 0
- 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)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run](#run)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**[Open Flights]** is a review app to allow users to add comments and review stars on airline flights.
React
Ruby on Rails
Database
Webpack
- **[Review Rating]**
- **A user can add flights company**
- **A user an rate the plane company on the form section**
- [Coming soon]()
To get a local copy up and running, follow these steps.
### Prerequisites
1. Before you go ahead with this project, please make sure you have:
- Basic understanding of HTML and CSS.
- JavaScript fundamentals (object, array, conditionals etc).
- Familiarity with JavaScript ES6 features (arrow functions, object destructuring etc).
- Basic understanding of basic Ruby concepts.
- Ruby fundamentals (modules, blocks, etc).
2. Make sure you have Ruby installed in your system. You can install it [here](https://www.ruby-lang.org/en/documentation/installation/)
3. Get started with [Ruby on Rails](https://guides.rubyonrails.org/getting_started.html)
4. Make sure you have [PostgreSQL](https://www.postgresql.org/) installed and running.
5. [Node and npm](https://nodejs.org/en/download/) are installed. Here are the versions I'll be using while making this tutorial:
```shell
$ node --version
v16.13.2
$ npm --version
8.1.2
$ yarn --version
1.22
```
> Installing npm adds two commands to the system—`npm` and `npx`—both of which I'll be using while making this tutorial.
```sh
cd your-desired-folder
git clone https://github.com/altontonn/OpenFlights
```
6. [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) is installed. Here's the version I'll be using while making this tutorial:
```shell
$ git --version
git version 2.29.1.windows.1
```
7. A [GitHub](https://github.com/signup)
8. [Ruby](https://rubyinstaller.org/downloads/) are installed. Here are the versions I'll be using while making this tutorial:
```shell
$ ruby --version
ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e) [x64-mingw-ucrt]
```
> Installing ruby add the command to the system—`irb` which we'll be using while making this tutorial.
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/altontonn/OpenFlights.git
```
### Install
Install this project with:
```sh
cd OpenFlights
bundle install
```
### Run
* Change/include `host, username, password` according to your database server.
* Run `rails db:create` and `rails db:migrate`
* Run `rails db:seed` to enter some data into database.
* Run `rails s` to start the server.
* In your browser, go to `http://localhost:3000`.
### Usage
To run the project, execute the following command:
```sh
### Usage
* To run and test use the `email: your email` and `password: 123456`
```
👤 **Newton Alumasa**
- [Github](https://github.com/altontonn/)
- [Twitter](https://twitter.com/AlumasaNewton)
- [Linkedin](https://www.linkedin.com/in/newton-alumasa/)
- [ ] **[Improve the application UI for small screen devices]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/altontonn/OpenFlights/issues).
If you like this project then please give a ⭐️ and also share your feeback using github issues.
I would like to thank ❤️ [Zayne Abraham](https://zayne.io/about) for his guidance tools and documentation.
This project is [MIT](https://github.com/altontonn/OpenFlights/blob/dev/LICENSE) licensed.