Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gjuliao/community-app

Ruby on Rails Community app with Hotwire Turbo and Stimulus. Implementation of ransack, kaminari, devise, Faker and many other gems.
https://github.com/gjuliao/community-app

Last synced: 16 days ago
JSON representation

Ruby on Rails Community app with Hotwire Turbo and Stimulus. Implementation of ransack, kaminari, devise, Faker and many other gems.

Awesome Lists containing this project

README 

        






Community App - (Linkedin Feautures)





# 📗 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)

- [❓ FAQ](#faq)

- [📝 License](#license)



# 📖 Community App 



** Community App is a platform that aims to mock similarities with Linkedin.  Allows users to connect with users, accept or reject requests while managing the amount of connections plus allowing users to add, edit and delete work experience.**



## 🛠 Built With 



### Tech Stack 



 



  This app was built with Rails.

  



### Key Features 



- **Adding, accepting and rejecting users invitations**

- **Allows users to add work experience.**

- **Manage your network of connections.**



(back to top)



## 🚀 Live Demo 



- [Pending deployment](https://pending-deployment.com/)



(back to top)



## 💻 Getting Started 



To get the content of this project locally you need to run the following commands in your terminal:



and follow these steps.



### Prerequisites



- IDE(code editor) like: **Vscode**, **Sublime**, etc.

- [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)



### Setup



Clone this repository to your desired folder:



1. Download the **Zip** file or clone the repo with:

   `bash git clone [email protected]:gjuliao/community-app.git`

2. To access cloned directory run:

   `bash cd community-app`

3. Open it with the live server



### Install



> To install linters and other project's dependencies run:

> `bundle install `



### Usage



To run the project, execute the following command:



### Run tests



To run tests, run the following command:



Test for Linters For tracking linter errors locally you need to follow these steps:



1. For tracking linter errors in HTML files run:

   `bash npx hint . `

2. For tracking linter errors in CSS or SASS files run:

   `bash npx stylelint "**/*.{css,scss}" `

3. For tracking linter errors in javascript files run:

   `bash npx eslint . `



### Deployment



You can deploy this project using:



(back to top)



## 👥 Authors 

👤 **Giovanni Juliao**



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



(back to top)



## 🔭 Future Features 



- [ ] **[Create a chat experience]**

- [ ] **[Add stripe for a PRO version]**

- [ ] **[Create company pages.]**



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



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



(back to top)



## ⭐️ Show your support 



> Write a message to encourage readers to support your project



If you like this project please give us a star!



(back to top)



## 🙏 Acknowledgments 



> Give credit to everyone who inspired your codebase.



I would like to thank to the rails team for making amazing programming language.



(back to top)



## 📝 License 



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



(back to top)