Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kidd254/airplanes_app

This web app is meant to display the details concerning aircrafts. A user can serach any particular aircraft by manufacturer to display aircraft details.
https://github.com/kidd254/airplanes_app

react-hooks react-router reactjs reactjs-components redux-toolkit tailwindcss typescript

Last synced: 27 days ago
JSON representation

This web app is meant to display the details concerning aircrafts. A user can serach any particular aircraft by manufacturer to display aircraft details.

Host: GitHub
URL: https://github.com/kidd254/airplanes_app
Owner: Kidd254
Created: 2024-03-02T20:01:49.000Z (9 months ago)
Default Branch: dev
Last Pushed: 2024-03-09T17:50:07.000Z (8 months ago)
Last Synced: 2024-03-09T18:39:42.542Z (8 months ago)
Topics: react-hooks, react-router, reactjs, reactjs-components, redux-toolkit, tailwindcss, typescript
Language: TypeScript
Homepage:
Size: 399 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        



  Rick_Morty_Mobile_App



# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [Blog App ](#blog-app-)

  - [🛠 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 ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

---

# Airplanes App 

**"Blog App"** is a website built with Ruby on Rails and PostgreSQL that allows users to create and publish posts, write comments, and like posts.

---

## 🛠 Built With 

### Tech Stack 

  Backend

  


    Ruby on Rails (v7.0.8)

    PostgreSQL

  


  Frontend

  


    HTML5

    CSS

    ERB template

  


### Key Features 



  Ruby on Rails framework

  

    Use Linters to check code quality

    

      Rubocop

      Stylelint

    

  

  MVC architectural/design pattern

  Data persistent in PostgreSQL

  Test the application with rspec

  Follow Microverse's list of best practices



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



    A code editor (we recommend Visual Studio Code)





    Git and a GitHub account



### Setup

Clone this repository to your desired folder by using this 👇️ command :

```

git clone https://github.com/Kidd254/BlogApp.git

```

### Install

Go to the project directory:

```

 cd blog-app

```

Before to run the program, verify that you have Ruby on Rails installed on your OS running the following command:

```

 rails --version

```

It should show you the version of ruby on rails installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby on Rails from scratch.

[Download and Install Ruby on Rails](https://guides.rubyonrails.org/getting_started.html)

### Usage

Run the following command inside the project folder to start the application:

```

 rails s

```

This will start the application on your local server. You can now open your browser and go to http://localhost:3000/ to see the application running.

### Run tests

To execute the tests, run the following command inside the project folder:

```

 rspec

```

(back to top)


---

## 👥 Authors 

👤 **Lawrence Muema Kioko**

- GitHub: [@kidd254](https://github.com/Kidd254)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/lawrence-muema-kioko)

(back to top)


---

## 🔭 Future Features 

Upcoming improvements:

- [x] Creating a data model

- [x] Processing data in models

- [x] Validations and model specs

- [x] Controllers

- [x] Views

- [ ] Forms

(back to top)


---

## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/NitBravoA92/blog-app/issues).

(back to top)


---

## ⭐️ Show your support 

If you like this project and know someone who might find it helpful, please share it.

Or give it a **star** ⭐️ if you like this project!

(back to top)


---

## 🙏 Acknowledgments 

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

(back to top)


---

## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)


---