📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Open-flight]

[Open Flights] is a review app to allow users to add comments and review stars on airline flights.

🛠 Built With

Tech Stack

React

• React.js

Ruby on Rails

• Ruby on Rails

Database

• PostgreSQL

Webpack

• Webpack

Key Features

• [Review Rating]
• A user can add flights company
• A user an rate the plane company on the form section

(back to top)

🚀 Live Demo

• Coming soon

(back to top)

💻 Getting Started

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

3. Get started with Ruby on Rails

4. Make sure you have PostgreSQL installed and running.

5. Node and npm are installed. Here are the versions I'll be using while making this tutorial:

$ 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 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

8. Ruby 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:

  cd my-folder
  git clone https://github.com/altontonn/OpenFlights.git

Install

Install this project with:

  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:

  ### Usage
  * To run and test use the `email: your email` and `password: 123456`

👥 Author

👤 Newton Alumasa

• Github
• Twitter
• Linkedin

(back to top)

🔭 Future Features

• [Improve the application UI for small screen devices]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project then please give a ⭐️ and also share your feeback using github issues.

(back to top)

🙏 Acknowledgments

I would like to thank ❤️ Zayne Abraham for his guidance tools and documentation.

(back to top)

📝 License

This project is MIT licensed.

(back to top)